selenium-webdriver 2.43.5 → 2.44.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (219) hide show
  1. package/CHANGES.md +20 -0
  2. package/README.md +8 -13
  3. package/builder.js +4 -3
  4. package/docs/class_webdriver_Alert.html +6 -6
  5. package/docs/class_webdriver_AlertPromise.html +6 -6
  6. package/docs/class_webdriver_UnhandledAlertError.html +4 -4
  7. package/docs/class_webdriver_WebDriver.html +39 -37
  8. package/docs/class_webdriver_WebDriver_Logs.html +3 -3
  9. package/docs/class_webdriver_WebDriver_Navigation.html +5 -5
  10. package/docs/class_webdriver_WebDriver_Options.html +9 -9
  11. package/docs/class_webdriver_WebDriver_TargetLocator.html +6 -6
  12. package/docs/class_webdriver_WebDriver_Timeouts.html +4 -4
  13. package/docs/class_webdriver_WebDriver_Window.html +6 -6
  14. package/docs/class_webdriver_WebElement.html +23 -23
  15. package/docs/class_webdriver_WebElementPromise.html +22 -22
  16. package/docs/class_webdriver_promise_CancellationError.html +3 -0
  17. package/docs/class_webdriver_promise_ControlFlow.html +32 -32
  18. package/docs/class_webdriver_promise_Deferred.html +7 -8
  19. package/docs/class_webdriver_promise_Frame_.html +14 -30
  20. package/docs/class_webdriver_promise_Promise.html +2 -2
  21. package/docs/class_webdriver_promise_Task_.html +12 -12
  22. package/docs/class_webdriver_until_Condition.html +3 -0
  23. package/docs/enum_webdriver_Key.html +1 -1
  24. package/docs/enum_webdriver_promise_ControlFlow_EventType.html +1 -1
  25. package/docs/enum_webdriver_promise_Deferred_State_.html +1 -1
  26. package/docs/index.html +8 -13
  27. package/docs/interface_webdriver_promise_Thenable.html +8 -10
  28. package/docs/license.html +1 -1
  29. package/docs/module_selenium-webdriver.html +2 -2
  30. package/docs/module_selenium-webdriver__base.html +1 -1
  31. package/docs/module_selenium-webdriver__base_class_Context.html +1 -1
  32. package/docs/module_selenium-webdriver_builder.html +1 -1
  33. package/docs/module_selenium-webdriver_builder_class_Builder.html +1 -1
  34. package/docs/module_selenium-webdriver_chrome.html +1 -1
  35. package/docs/module_selenium-webdriver_chrome_class_Driver.html +2 -2
  36. package/docs/module_selenium-webdriver_chrome_class_Options.html +2 -2
  37. package/docs/module_selenium-webdriver_chrome_class_ServiceBuilder.html +1 -1
  38. package/docs/module_selenium-webdriver_error.html +1 -1
  39. package/docs/module_selenium-webdriver_executors.html +1 -1
  40. package/docs/module_selenium-webdriver_firefox.html +1 -1
  41. package/docs/module_selenium-webdriver_firefox_binary.html +1 -1
  42. package/docs/module_selenium-webdriver_firefox_binary_class_Binary.html +1 -1
  43. package/docs/module_selenium-webdriver_firefox_class_Driver.html +2 -2
  44. package/docs/module_selenium-webdriver_firefox_class_Options.html +1 -1
  45. package/docs/module_selenium-webdriver_firefox_extension.html +1 -1
  46. package/docs/module_selenium-webdriver_firefox_profile.html +1 -1
  47. package/docs/module_selenium-webdriver_firefox_profile_class_Profile.html +1 -1
  48. package/docs/module_selenium-webdriver_http.html +1 -1
  49. package/docs/module_selenium-webdriver_http_class_HttpClient.html +1 -1
  50. package/docs/module_selenium-webdriver_http_util.html +1 -1
  51. package/docs/module_selenium-webdriver_io.html +1 -1
  52. package/docs/module_selenium-webdriver_io_exec.html +1 -1
  53. package/docs/module_selenium-webdriver_net.html +1 -1
  54. package/docs/module_selenium-webdriver_net_portprober.html +1 -1
  55. package/docs/module_selenium-webdriver_phantomjs.html +1 -1
  56. package/docs/module_selenium-webdriver_phantomjs_class_Driver.html +2 -2
  57. package/docs/module_selenium-webdriver_proxy.html +1 -1
  58. package/docs/module_selenium-webdriver_remote.html +1 -1
  59. package/docs/module_selenium-webdriver_remote_class_DriverService.html +2 -2
  60. package/docs/module_selenium-webdriver_remote_class_SeleniumServer.html +2 -2
  61. package/docs/module_selenium-webdriver_testing.html +16 -29
  62. package/docs/module_selenium-webdriver_testing_assert.html +1 -1
  63. package/docs/namespace_webdriver_promise.html +18 -20
  64. package/docs/namespace_webdriver_stacktrace.html +15 -15
  65. package/docs/namespace_webdriver_until.html +32 -0
  66. package/docs/source/_base.js.src.html +1 -1
  67. package/docs/source/builder.js.src.html +1 -1
  68. package/docs/source/chrome.js.src.html +1 -1
  69. package/docs/source/error.js.src.html +1 -1
  70. package/docs/source/executors.js.src.html +1 -1
  71. package/docs/source/firefox/binary.js.src.html +1 -1
  72. package/docs/source/firefox/extension.js.src.html +1 -1
  73. package/docs/source/firefox/index.js.src.html +1 -1
  74. package/docs/source/firefox/profile.js.src.html +1 -1
  75. package/docs/source/http/index.js.src.html +1 -1
  76. package/docs/source/http/util.js.src.html +1 -1
  77. package/docs/source/index.js.src.html +1 -1
  78. package/docs/source/io/exec.js.src.html +1 -1
  79. package/docs/source/io/index.js.src.html +1 -1
  80. package/docs/source/lib/atoms/error.js.src.html +1 -1
  81. package/docs/source/lib/atoms/json.js.src.html +1 -1
  82. package/docs/source/lib/atoms/response.js.src.html +1 -1
  83. package/docs/source/lib/atoms/userAgent.js.src.html +1 -1
  84. package/docs/source/lib/goog/array/array.js.src.html +1 -1
  85. package/docs/source/lib/goog/asserts/asserts.js.src.html +1 -1
  86. package/docs/source/lib/goog/async/nexttick.js.src.html +1 -1
  87. package/docs/source/lib/goog/async/run.js.src.html +1 -1
  88. package/docs/source/lib/goog/base.js.src.html +1 -1
  89. package/docs/source/lib/goog/debug/debug.js.src.html +1 -1
  90. package/docs/source/lib/goog/debug/entrypointregistry.js.src.html +1 -1
  91. package/docs/source/lib/goog/debug/error.js.src.html +1 -1
  92. package/docs/source/lib/goog/debug/logbuffer.js.src.html +1 -1
  93. package/docs/source/lib/goog/debug/logger.js.src.html +1 -1
  94. package/docs/source/lib/goog/debug/logrecord.js.src.html +1 -1
  95. package/docs/source/lib/goog/deps.js.src.html +1 -1
  96. package/docs/source/lib/goog/disposable/disposable.js.src.html +1 -1
  97. package/docs/source/lib/goog/disposable/idisposable.js.src.html +1 -1
  98. package/docs/source/lib/goog/dom/browserfeature.js.src.html +1 -1
  99. package/docs/source/lib/goog/dom/dom.js.src.html +1 -1
  100. package/docs/source/lib/goog/dom/nodetype.js.src.html +1 -1
  101. package/docs/source/lib/goog/dom/tagname.js.src.html +1 -1
  102. package/docs/source/lib/goog/dom/vendor.js.src.html +1 -1
  103. package/docs/source/lib/goog/events/browserevent.js.src.html +1 -1
  104. package/docs/source/lib/goog/events/browserfeature.js.src.html +1 -1
  105. package/docs/source/lib/goog/events/event.js.src.html +1 -1
  106. package/docs/source/lib/goog/events/eventid.js.src.html +1 -1
  107. package/docs/source/lib/goog/events/events.js.src.html +1 -1
  108. package/docs/source/lib/goog/events/eventtarget.js.src.html +1 -1
  109. package/docs/source/lib/goog/events/eventtype.js.src.html +1 -1
  110. package/docs/source/lib/goog/events/keycodes.js.src.html +1 -1
  111. package/docs/source/lib/goog/events/listenable.js.src.html +1 -1
  112. package/docs/source/lib/goog/events/listener.js.src.html +1 -1
  113. package/docs/source/lib/goog/events/listenermap.js.src.html +1 -1
  114. package/docs/source/lib/goog/functions/functions.js.src.html +1 -1
  115. package/docs/source/lib/goog/iter/iter.js.src.html +1 -1
  116. package/docs/source/lib/goog/json/json.js.src.html +1 -1
  117. package/docs/source/lib/goog/labs/testing/assertthat.js.src.html +1 -1
  118. package/docs/source/lib/goog/labs/testing/logicmatcher.js.src.html +1 -1
  119. package/docs/source/lib/goog/labs/testing/matcher.js.src.html +1 -1
  120. package/docs/source/lib/goog/labs/testing/numbermatcher.js.src.html +1 -1
  121. package/docs/source/lib/goog/labs/testing/objectmatcher.js.src.html +1 -1
  122. package/docs/source/lib/goog/labs/testing/stringmatcher.js.src.html +1 -1
  123. package/docs/source/lib/goog/labs/useragent/browser.js.src.html +1 -1
  124. package/docs/source/lib/goog/labs/useragent/engine.js.src.html +1 -1
  125. package/docs/source/lib/goog/labs/useragent/util.js.src.html +1 -1
  126. package/docs/source/lib/goog/math/box.js.src.html +1 -1
  127. package/docs/source/lib/goog/math/coordinate.js.src.html +1 -1
  128. package/docs/source/lib/goog/math/math.js.src.html +1 -1
  129. package/docs/source/lib/goog/math/rect.js.src.html +1 -1
  130. package/docs/source/lib/goog/math/size.js.src.html +1 -1
  131. package/docs/source/lib/goog/net/wrapperxmlhttpfactory.js.src.html +1 -1
  132. package/docs/source/lib/goog/net/xhrlike.js.src.html +1 -1
  133. package/docs/source/lib/goog/net/xmlhttp.js.src.html +1 -1
  134. package/docs/source/lib/goog/net/xmlhttpfactory.js.src.html +1 -1
  135. package/docs/source/lib/goog/object/object.js.src.html +1 -1
  136. package/docs/source/lib/goog/reflect/reflect.js.src.html +1 -1
  137. package/docs/source/lib/goog/string/string.js.src.html +1 -1
  138. package/docs/source/lib/goog/structs/collection.js.src.html +1 -1
  139. package/docs/source/lib/goog/structs/map.js.src.html +1 -1
  140. package/docs/source/lib/goog/structs/set.js.src.html +1 -1
  141. package/docs/source/lib/goog/structs/structs.js.src.html +1 -1
  142. package/docs/source/lib/goog/style/style.js.src.html +1 -1
  143. package/docs/source/lib/goog/testing/asserts.js.src.html +1 -1
  144. package/docs/source/lib/goog/testing/asynctestcase.js.src.html +1 -1
  145. package/docs/source/lib/goog/testing/events/events.js.src.html +1 -1
  146. package/docs/source/lib/goog/testing/functionmock.js.src.html +1 -1
  147. package/docs/source/lib/goog/testing/jsunit.js.src.html +1 -1
  148. package/docs/source/lib/goog/testing/loosemock.js.src.html +1 -1
  149. package/docs/source/lib/goog/testing/mock.js.src.html +1 -1
  150. package/docs/source/lib/goog/testing/mockclock.js.src.html +1 -1
  151. package/docs/source/lib/goog/testing/mockcontrol.js.src.html +1 -1
  152. package/docs/source/lib/goog/testing/mockinterface.js.src.html +1 -1
  153. package/docs/source/lib/goog/testing/mockmatchers.js.src.html +1 -1
  154. package/docs/source/lib/goog/testing/objectpropertystring.js.src.html +1 -1
  155. package/docs/source/lib/goog/testing/propertyreplacer.js.src.html +1 -1
  156. package/docs/source/lib/goog/testing/recordfunction.js.src.html +1 -1
  157. package/docs/source/lib/goog/testing/stacktrace.js.src.html +1 -1
  158. package/docs/source/lib/goog/testing/strictmock.js.src.html +1 -1
  159. package/docs/source/lib/goog/testing/testcase.js.src.html +1 -1
  160. package/docs/source/lib/goog/testing/testrunner.js.src.html +1 -1
  161. package/docs/source/lib/goog/testing/watchers.js.src.html +1 -1
  162. package/docs/source/lib/goog/uri/uri.js.src.html +1 -1
  163. package/docs/source/lib/goog/uri/utils.js.src.html +1 -1
  164. package/docs/source/lib/goog/useragent/product.js.src.html +1 -1
  165. package/docs/source/lib/goog/useragent/product_isversion.js.src.html +1 -1
  166. package/docs/source/lib/goog/useragent/useragent.js.src.html +1 -1
  167. package/docs/source/lib/webdriver/abstractbuilder.js.src.html +1 -1
  168. package/docs/source/lib/webdriver/actionsequence.js.src.html +1 -1
  169. package/docs/source/lib/webdriver/builder.js.src.html +1 -1
  170. package/docs/source/lib/webdriver/button.js.src.html +1 -1
  171. package/docs/source/lib/webdriver/capabilities.js.src.html +1 -1
  172. package/docs/source/lib/webdriver/command.js.src.html +1 -1
  173. package/docs/source/lib/webdriver/events.js.src.html +1 -1
  174. package/docs/source/lib/webdriver/firefoxdomexecutor.js.src.html +1 -1
  175. package/docs/source/lib/webdriver/http/corsclient.js.src.html +1 -1
  176. package/docs/source/lib/webdriver/http/http.js.src.html +1 -1
  177. package/docs/source/lib/webdriver/http/xhrclient.js.src.html +1 -1
  178. package/docs/source/lib/webdriver/key.js.src.html +1 -1
  179. package/docs/source/lib/webdriver/locators.js.src.html +1 -1
  180. package/docs/source/lib/webdriver/logging.js.src.html +1 -1
  181. package/docs/source/lib/webdriver/process.js.src.html +1 -1
  182. package/docs/source/lib/webdriver/promise.js.src.html +1 -1
  183. package/docs/source/lib/webdriver/session.js.src.html +1 -1
  184. package/docs/source/lib/webdriver/stacktrace.js.src.html +1 -1
  185. package/docs/source/lib/webdriver/testing/asserts.js.src.html +1 -1
  186. package/docs/source/lib/webdriver/testing/testcase.js.src.html +1 -1
  187. package/docs/source/lib/webdriver/until.js.src.html +1 -0
  188. package/docs/source/lib/webdriver/webdriver.js.src.html +1 -1
  189. package/docs/source/net/index.js.src.html +1 -1
  190. package/docs/source/net/portprober.js.src.html +1 -1
  191. package/docs/source/phantomjs.js.src.html +1 -1
  192. package/docs/source/proxy.js.src.html +1 -1
  193. package/docs/source/remote/index.js.src.html +1 -1
  194. package/docs/source/testing/assert.js.src.html +1 -1
  195. package/docs/source/testing/index.js.src.html +1 -1
  196. package/docs/types.js +1 -1
  197. package/example/google_search.js +9 -17
  198. package/example/google_search_generator.js +6 -7
  199. package/example/google_search_test.js +10 -18
  200. package/example/parallel_flows.js +4 -7
  201. package/index.js +6 -0
  202. package/lib/firefox/webdriver.xpi +0 -0
  203. package/lib/goog/deps.js +7 -5
  204. package/lib/test/index.js +0 -8
  205. package/lib/webdriver/promise.js +263 -251
  206. package/lib/webdriver/stacktrace.js +15 -1
  207. package/lib/webdriver/test/promise_flow_test.js +82 -76
  208. package/lib/webdriver/test/promise_test.js +22 -62
  209. package/lib/webdriver/test/stacktrace_test.js +18 -0
  210. package/lib/webdriver/test/until_test.js +388 -0
  211. package/lib/webdriver/test/webdriver_test.js +41 -0
  212. package/lib/webdriver/until.js +408 -0
  213. package/lib/webdriver/webdriver.js +91 -29
  214. package/package.json +2 -2
  215. package/test/element_finding_test.js +6 -6
  216. package/test/http/util_test.js +4 -5
  217. package/test/page_loading_test.js +7 -7
  218. package/test/stale_element_test.js +2 -10
  219. package/testing/index.js +9 -22
package/docs/source/lib/goog/events/keycodes.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>keycodes.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/events/keycodes.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2006 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Constant declarations for common key codes.<tr><td><a name="l17" href="#l17">17</a><td> *<tr><td><a name="l18" href="#l18">18</a><td> * @author eae@google.com (Emil A Eklund)<tr><td><a name="l19" href="#l19">19</a><td> * @see ../demos/keyhandler.html<tr><td><a name="l20" href="#l20">20</a><td> */<tr><td><a name="l21" href="#l21">21</a><td><tr><td><a name="l22" href="#l22">22</a><td>goog.provide(&#39;goog.events.KeyCodes&#39;);<tr><td><a name="l23" href="#l23">23</a><td><tr><td><a name="l24" href="#l24">24</a><td>goog.require(&#39;goog.userAgent&#39;);<tr><td><a name="l25" href="#l25">25</a><td><tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td>/**<tr><td><a name="l28" href="#l28">28</a><td> * Key codes for common characters.<tr><td><a name="l29" href="#l29">29</a><td> *<tr><td><a name="l30" href="#l30">30</a><td> * This list is not localized and therefore some of the key codes are not<tr><td><a name="l31" href="#l31">31</a><td> * correct for non US keyboard layouts. See comments below.<tr><td><a name="l32" href="#l32">32</a><td> *<tr><td><a name="l33" href="#l33">33</a><td> * @enum {number}<tr><td><a name="l34" href="#l34">34</a><td> */<tr><td><a name="l35" href="#l35">35</a><td>goog.events.KeyCodes = {<tr><td><a name="l36" href="#l36">36</a><td> WIN_KEY_FF_LINUX: 0,<tr><td><a name="l37" href="#l37">37</a><td> MAC_ENTER: 3,<tr><td><a name="l38" href="#l38">38</a><td> BACKSPACE: 8,<tr><td><a name="l39" href="#l39">39</a><td> TAB: 9,<tr><td><a name="l40" href="#l40">40</a><td> NUM_CENTER: 12, // NUMLOCK on FF/Safari Mac<tr><td><a name="l41" href="#l41">41</a><td> ENTER: 13,<tr><td><a name="l42" href="#l42">42</a><td> SHIFT: 16,<tr><td><a name="l43" href="#l43">43</a><td> CTRL: 17,<tr><td><a name="l44" href="#l44">44</a><td> ALT: 18,<tr><td><a name="l45" href="#l45">45</a><td> PAUSE: 19,<tr><td><a name="l46" href="#l46">46</a><td> CAPS_LOCK: 20,<tr><td><a name="l47" href="#l47">47</a><td> ESC: 27,<tr><td><a name="l48" href="#l48">48</a><td> SPACE: 32,<tr><td><a name="l49" href="#l49">49</a><td> PAGE_UP: 33, // also NUM_NORTH_EAST<tr><td><a name="l50" href="#l50">50</a><td> PAGE_DOWN: 34, // also NUM_SOUTH_EAST<tr><td><a name="l51" href="#l51">51</a><td> END: 35, // also NUM_SOUTH_WEST<tr><td><a name="l52" href="#l52">52</a><td> HOME: 36, // also NUM_NORTH_WEST<tr><td><a name="l53" href="#l53">53</a><td> LEFT: 37, // also NUM_WEST<tr><td><a name="l54" href="#l54">54</a><td> UP: 38, // also NUM_NORTH<tr><td><a name="l55" href="#l55">55</a><td> RIGHT: 39, // also NUM_EAST<tr><td><a name="l56" href="#l56">56</a><td> DOWN: 40, // also NUM_SOUTH<tr><td><a name="l57" href="#l57">57</a><td> PRINT_SCREEN: 44,<tr><td><a name="l58" href="#l58">58</a><td> INSERT: 45, // also NUM_INSERT<tr><td><a name="l59" href="#l59">59</a><td> DELETE: 46, // also NUM_DELETE<tr><td><a name="l60" href="#l60">60</a><td> ZERO: 48,<tr><td><a name="l61" href="#l61">61</a><td> ONE: 49,<tr><td><a name="l62" href="#l62">62</a><td> TWO: 50,<tr><td><a name="l63" href="#l63">63</a><td> THREE: 51,<tr><td><a name="l64" href="#l64">64</a><td> FOUR: 52,<tr><td><a name="l65" href="#l65">65</a><td> FIVE: 53,<tr><td><a name="l66" href="#l66">66</a><td> SIX: 54,<tr><td><a name="l67" href="#l67">67</a><td> SEVEN: 55,<tr><td><a name="l68" href="#l68">68</a><td> EIGHT: 56,<tr><td><a name="l69" href="#l69">69</a><td> NINE: 57,<tr><td><a name="l70" href="#l70">70</a><td> FF_SEMICOLON: 59, // Firefox (Gecko) fires this for semicolon instead of 186<tr><td><a name="l71" href="#l71">71</a><td> FF_EQUALS: 61, // Firefox (Gecko) fires this for equals instead of 187<tr><td><a name="l72" href="#l72">72</a><td> FF_DASH: 173, // Firefox (Gecko) fires this for dash instead of 189<tr><td><a name="l73" href="#l73">73</a><td> QUESTION_MARK: 63, // needs localization<tr><td><a name="l74" href="#l74">74</a><td> A: 65,<tr><td><a name="l75" href="#l75">75</a><td> B: 66,<tr><td><a name="l76" href="#l76">76</a><td> C: 67,<tr><td><a name="l77" href="#l77">77</a><td> D: 68,<tr><td><a name="l78" href="#l78">78</a><td> E: 69,<tr><td><a name="l79" href="#l79">79</a><td> F: 70,<tr><td><a name="l80" href="#l80">80</a><td> G: 71,<tr><td><a name="l81" href="#l81">81</a><td> H: 72,<tr><td><a name="l82" href="#l82">82</a><td> I: 73,<tr><td><a name="l83" href="#l83">83</a><td> J: 74,<tr><td><a name="l84" href="#l84">84</a><td> K: 75,<tr><td><a name="l85" href="#l85">85</a><td> L: 76,<tr><td><a name="l86" href="#l86">86</a><td> M: 77,<tr><td><a name="l87" href="#l87">87</a><td> N: 78,<tr><td><a name="l88" href="#l88">88</a><td> O: 79,<tr><td><a name="l89" href="#l89">89</a><td> P: 80,<tr><td><a name="l90" href="#l90">90</a><td> Q: 81,<tr><td><a name="l91" href="#l91">91</a><td> R: 82,<tr><td><a name="l92" href="#l92">92</a><td> S: 83,<tr><td><a name="l93" href="#l93">93</a><td> T: 84,<tr><td><a name="l94" href="#l94">94</a><td> U: 85,<tr><td><a name="l95" href="#l95">95</a><td> V: 86,<tr><td><a name="l96" href="#l96">96</a><td> W: 87,<tr><td><a name="l97" href="#l97">97</a><td> X: 88,<tr><td><a name="l98" href="#l98">98</a><td> Y: 89,<tr><td><a name="l99" href="#l99">99</a><td> Z: 90,<tr><td><a name="l100" href="#l100">100</a><td> META: 91, // WIN_KEY_LEFT<tr><td><a name="l101" href="#l101">101</a><td> WIN_KEY_RIGHT: 92,<tr><td><a name="l102" href="#l102">102</a><td> CONTEXT_MENU: 93,<tr><td><a name="l103" href="#l103">103</a><td> NUM_ZERO: 96,<tr><td><a name="l104" href="#l104">104</a><td> NUM_ONE: 97,<tr><td><a name="l105" href="#l105">105</a><td> NUM_TWO: 98,<tr><td><a name="l106" href="#l106">106</a><td> NUM_THREE: 99,<tr><td><a name="l107" href="#l107">107</a><td> NUM_FOUR: 100,<tr><td><a name="l108" href="#l108">108</a><td> NUM_FIVE: 101,<tr><td><a name="l109" href="#l109">109</a><td> NUM_SIX: 102,<tr><td><a name="l110" href="#l110">110</a><td> NUM_SEVEN: 103,<tr><td><a name="l111" href="#l111">111</a><td> NUM_EIGHT: 104,<tr><td><a name="l112" href="#l112">112</a><td> NUM_NINE: 105,<tr><td><a name="l113" href="#l113">113</a><td> NUM_MULTIPLY: 106,<tr><td><a name="l114" href="#l114">114</a><td> NUM_PLUS: 107,<tr><td><a name="l115" href="#l115">115</a><td> NUM_MINUS: 109,<tr><td><a name="l116" href="#l116">116</a><td> NUM_PERIOD: 110,<tr><td><a name="l117" href="#l117">117</a><td> NUM_DIVISION: 111,<tr><td><a name="l118" href="#l118">118</a><td> F1: 112,<tr><td><a name="l119" href="#l119">119</a><td> F2: 113,<tr><td><a name="l120" href="#l120">120</a><td> F3: 114,<tr><td><a name="l121" href="#l121">121</a><td> F4: 115,<tr><td><a name="l122" href="#l122">122</a><td> F5: 116,<tr><td><a name="l123" href="#l123">123</a><td> F6: 117,<tr><td><a name="l124" href="#l124">124</a><td> F7: 118,<tr><td><a name="l125" href="#l125">125</a><td> F8: 119,<tr><td><a name="l126" href="#l126">126</a><td> F9: 120,<tr><td><a name="l127" href="#l127">127</a><td> F10: 121,<tr><td><a name="l128" href="#l128">128</a><td> F11: 122,<tr><td><a name="l129" href="#l129">129</a><td> F12: 123,<tr><td><a name="l130" href="#l130">130</a><td> NUMLOCK: 144,<tr><td><a name="l131" href="#l131">131</a><td> SCROLL_LOCK: 145,<tr><td><a name="l132" href="#l132">132</a><td><tr><td><a name="l133" href="#l133">133</a><td> // OS-specific media keys like volume controls and browser controls.<tr><td><a name="l134" href="#l134">134</a><td> FIRST_MEDIA_KEY: 166,<tr><td><a name="l135" href="#l135">135</a><td> LAST_MEDIA_KEY: 183,<tr><td><a name="l136" href="#l136">136</a><td><tr><td><a name="l137" href="#l137">137</a><td> SEMICOLON: 186, // needs localization<tr><td><a name="l138" href="#l138">138</a><td> DASH: 189, // needs localization<tr><td><a name="l139" href="#l139">139</a><td> EQUALS: 187, // needs localization<tr><td><a name="l140" href="#l140">140</a><td> COMMA: 188, // needs localization<tr><td><a name="l141" href="#l141">141</a><td> PERIOD: 190, // needs localization<tr><td><a name="l142" href="#l142">142</a><td> SLASH: 191, // needs localization<tr><td><a name="l143" href="#l143">143</a><td> APOSTROPHE: 192, // needs localization<tr><td><a name="l144" href="#l144">144</a><td> TILDE: 192, // needs localization<tr><td><a name="l145" href="#l145">145</a><td> SINGLE_QUOTE: 222, // needs localization<tr><td><a name="l146" href="#l146">146</a><td> OPEN_SQUARE_BRACKET: 219, // needs localization<tr><td><a name="l147" href="#l147">147</a><td> BACKSLASH: 220, // needs localization<tr><td><a name="l148" href="#l148">148</a><td> CLOSE_SQUARE_BRACKET: 221, // needs localization<tr><td><a name="l149" href="#l149">149</a><td> WIN_KEY: 224,<tr><td><a name="l150" href="#l150">150</a><td> MAC_FF_META: 224, // Firefox (Gecko) fires this for the meta key instead of 91<tr><td><a name="l151" href="#l151">151</a><td> MAC_WK_CMD_LEFT: 91, // WebKit Left Command key fired, same as META<tr><td><a name="l152" href="#l152">152</a><td> MAC_WK_CMD_RIGHT: 93, // WebKit Right Command key fired, different from META<tr><td><a name="l153" href="#l153">153</a><td> WIN_IME: 229,<tr><td><a name="l154" href="#l154">154</a><td><tr><td><a name="l155" href="#l155">155</a><td> // We&#39;ve seen users whose machines fire this keycode at regular one<tr><td><a name="l156" href="#l156">156</a><td> // second intervals. The common thread among these users is that<tr><td><a name="l157" href="#l157">157</a><td> // they&#39;re all using Dell Inspiron laptops, so we suspect that this<tr><td><a name="l158" href="#l158">158</a><td> // indicates a hardware/bios problem.<tr><td><a name="l159" href="#l159">159</a><td> // http://en.community.dell.com/support-forums/laptop/f/3518/p/19285957/19523128.aspx<tr><td><a name="l160" href="#l160">160</a><td> PHANTOM: 255<tr><td><a name="l161" href="#l161">161</a><td>};<tr><td><a name="l162" href="#l162">162</a><td><tr><td><a name="l163" href="#l163">163</a><td><tr><td><a name="l164" href="#l164">164</a><td>/**<tr><td><a name="l165" href="#l165">165</a><td> * Returns true if the event contains a text modifying key.<tr><td><a name="l166" href="#l166">166</a><td> * @param {goog.events.BrowserEvent} e A key event.<tr><td><a name="l167" href="#l167">167</a><td> * @return {boolean} Whether it&#39;s a text modifying key.<tr><td><a name="l168" href="#l168">168</a><td> */<tr><td><a name="l169" href="#l169">169</a><td>goog.events.KeyCodes.isTextModifyingKeyEvent = function(e) {<tr><td><a name="l170" href="#l170">170</a><td> if (e.altKey &amp;&amp; !e.ctrlKey ||<tr><td><a name="l171" href="#l171">171</a><td> e.metaKey ||<tr><td><a name="l172" href="#l172">172</a><td> // Function keys don&#39;t generate text<tr><td><a name="l173" href="#l173">173</a><td> e.keyCode &gt;= goog.events.KeyCodes.F1 &amp;&amp;<tr><td><a name="l174" href="#l174">174</a><td> e.keyCode &lt;= goog.events.KeyCodes.F12) {<tr><td><a name="l175" href="#l175">175</a><td> return false;<tr><td><a name="l176" href="#l176">176</a><td> }<tr><td><a name="l177" href="#l177">177</a><td><tr><td><a name="l178" href="#l178">178</a><td> // The following keys are quite harmless, even in combination with<tr><td><a name="l179" href="#l179">179</a><td> // CTRL, ALT or SHIFT.<tr><td><a name="l180" href="#l180">180</a><td> switch (e.keyCode) {<tr><td><a name="l181" href="#l181">181</a><td> case goog.events.KeyCodes.ALT:<tr><td><a name="l182" href="#l182">182</a><td> case goog.events.KeyCodes.CAPS_LOCK:<tr><td><a name="l183" href="#l183">183</a><td> case goog.events.KeyCodes.CONTEXT_MENU:<tr><td><a name="l184" href="#l184">184</a><td> case goog.events.KeyCodes.CTRL:<tr><td><a name="l185" href="#l185">185</a><td> case goog.events.KeyCodes.DOWN:<tr><td><a name="l186" href="#l186">186</a><td> case goog.events.KeyCodes.END:<tr><td><a name="l187" href="#l187">187</a><td> case goog.events.KeyCodes.ESC:<tr><td><a name="l188" href="#l188">188</a><td> case goog.events.KeyCodes.HOME:<tr><td><a name="l189" href="#l189">189</a><td> case goog.events.KeyCodes.INSERT:<tr><td><a name="l190" href="#l190">190</a><td> case goog.events.KeyCodes.LEFT:<tr><td><a name="l191" href="#l191">191</a><td> case goog.events.KeyCodes.MAC_FF_META:<tr><td><a name="l192" href="#l192">192</a><td> case goog.events.KeyCodes.META:<tr><td><a name="l193" href="#l193">193</a><td> case goog.events.KeyCodes.NUMLOCK:<tr><td><a name="l194" href="#l194">194</a><td> case goog.events.KeyCodes.NUM_CENTER:<tr><td><a name="l195" href="#l195">195</a><td> case goog.events.KeyCodes.PAGE_DOWN:<tr><td><a name="l196" href="#l196">196</a><td> case goog.events.KeyCodes.PAGE_UP:<tr><td><a name="l197" href="#l197">197</a><td> case goog.events.KeyCodes.PAUSE:<tr><td><a name="l198" href="#l198">198</a><td> case goog.events.KeyCodes.PHANTOM:<tr><td><a name="l199" href="#l199">199</a><td> case goog.events.KeyCodes.PRINT_SCREEN:<tr><td><a name="l200" href="#l200">200</a><td> case goog.events.KeyCodes.RIGHT:<tr><td><a name="l201" href="#l201">201</a><td> case goog.events.KeyCodes.SCROLL_LOCK:<tr><td><a name="l202" href="#l202">202</a><td> case goog.events.KeyCodes.SHIFT:<tr><td><a name="l203" href="#l203">203</a><td> case goog.events.KeyCodes.UP:<tr><td><a name="l204" href="#l204">204</a><td> case goog.events.KeyCodes.WIN_KEY:<tr><td><a name="l205" href="#l205">205</a><td> case goog.events.KeyCodes.WIN_KEY_RIGHT:<tr><td><a name="l206" href="#l206">206</a><td> return false;<tr><td><a name="l207" href="#l207">207</a><td> case goog.events.KeyCodes.WIN_KEY_FF_LINUX:<tr><td><a name="l208" href="#l208">208</a><td> return !goog.userAgent.GECKO;<tr><td><a name="l209" href="#l209">209</a><td> default:<tr><td><a name="l210" href="#l210">210</a><td> return e.keyCode &lt; goog.events.KeyCodes.FIRST_MEDIA_KEY ||<tr><td><a name="l211" href="#l211">211</a><td> e.keyCode &gt; goog.events.KeyCodes.LAST_MEDIA_KEY;<tr><td><a name="l212" href="#l212">212</a><td> }<tr><td><a name="l213" href="#l213">213</a><td>};<tr><td><a name="l214" href="#l214">214</a><td><tr><td><a name="l215" href="#l215">215</a><td><tr><td><a name="l216" href="#l216">216</a><td>/**<tr><td><a name="l217" href="#l217">217</a><td> * Returns true if the key fires a keypress event in the current browser.<tr><td><a name="l218" href="#l218">218</a><td> *<tr><td><a name="l219" href="#l219">219</a><td> * Accoridng to MSDN [1] IE only fires keypress events for the following keys:<tr><td><a name="l220" href="#l220">220</a><td> * - Letters: A - Z (uppercase and lowercase)<tr><td><a name="l221" href="#l221">221</a><td> * - Numerals: 0 - 9<tr><td><a name="l222" href="#l222">222</a><td> * - Symbols: ! @ # $ % ^ &amp; * ( ) _ - + = &lt; [ ] { } , . / ? \ | &#39; ` &quot; ~<tr><td><a name="l223" href="#l223">223</a><td> * - System: ESC, SPACEBAR, ENTER<tr><td><a name="l224" href="#l224">224</a><td> *<tr><td><a name="l225" href="#l225">225</a><td> * That&#39;s not entirely correct though, for instance there&#39;s no distinction<tr><td><a name="l226" href="#l226">226</a><td> * between upper and lower case letters.<tr><td><a name="l227" href="#l227">227</a><td> *<tr><td><a name="l228" href="#l228">228</a><td> * [1] http://msdn2.microsoft.com/en-us/library/ms536939(VS.85).aspx)<tr><td><a name="l229" href="#l229">229</a><td> *<tr><td><a name="l230" href="#l230">230</a><td> * Safari is similar to IE, but does not fire keypress for ESC.<tr><td><a name="l231" href="#l231">231</a><td> *<tr><td><a name="l232" href="#l232">232</a><td> * Additionally, IE6 does not fire keydown or keypress events for letters when<tr><td><a name="l233" href="#l233">233</a><td> * the control or alt keys are held down and the shift key is not. IE7 does<tr><td><a name="l234" href="#l234">234</a><td> * fire keydown in these cases, though, but not keypress.<tr><td><a name="l235" href="#l235">235</a><td> *<tr><td><a name="l236" href="#l236">236</a><td> * @param {number} keyCode A key code.<tr><td><a name="l237" href="#l237">237</a><td> * @param {number=} opt_heldKeyCode Key code of a currently-held key.<tr><td><a name="l238" href="#l238">238</a><td> * @param {boolean=} opt_shiftKey Whether the shift key is held down.<tr><td><a name="l239" href="#l239">239</a><td> * @param {boolean=} opt_ctrlKey Whether the control key is held down.<tr><td><a name="l240" href="#l240">240</a><td> * @param {boolean=} opt_altKey Whether the alt key is held down.<tr><td><a name="l241" href="#l241">241</a><td> * @return {boolean} Whether it&#39;s a key that fires a keypress event.<tr><td><a name="l242" href="#l242">242</a><td> */<tr><td><a name="l243" href="#l243">243</a><td>goog.events.KeyCodes.firesKeyPressEvent = function(keyCode, opt_heldKeyCode,<tr><td><a name="l244" href="#l244">244</a><td> opt_shiftKey, opt_ctrlKey, opt_altKey) {<tr><td><a name="l245" href="#l245">245</a><td> if (!goog.userAgent.IE &amp;&amp;<tr><td><a name="l246" href="#l246">246</a><td> !(goog.userAgent.WEBKIT &amp;&amp; goog.userAgent.isVersionOrHigher(&#39;525&#39;))) {<tr><td><a name="l247" href="#l247">247</a><td> return true;<tr><td><a name="l248" href="#l248">248</a><td> }<tr><td><a name="l249" href="#l249">249</a><td><tr><td><a name="l250" href="#l250">250</a><td> if (goog.userAgent.MAC &amp;&amp; opt_altKey) {<tr><td><a name="l251" href="#l251">251</a><td> return goog.events.KeyCodes.isCharacterKey(keyCode);<tr><td><a name="l252" href="#l252">252</a><td> }<tr><td><a name="l253" href="#l253">253</a><td><tr><td><a name="l254" href="#l254">254</a><td> // Alt but not AltGr which is represented as Alt+Ctrl.<tr><td><a name="l255" href="#l255">255</a><td> if (opt_altKey &amp;&amp; !opt_ctrlKey) {<tr><td><a name="l256" href="#l256">256</a><td> return false;<tr><td><a name="l257" href="#l257">257</a><td> }<tr><td><a name="l258" href="#l258">258</a><td><tr><td><a name="l259" href="#l259">259</a><td> // Saves Ctrl or Alt + key for IE and WebKit 525+, which won&#39;t fire keypress.<tr><td><a name="l260" href="#l260">260</a><td> // Non-IE browsers and WebKit prior to 525 won&#39;t get this far so no need to<tr><td><a name="l261" href="#l261">261</a><td> // check the user agent.<tr><td><a name="l262" href="#l262">262</a><td> if (goog.isNumber(opt_heldKeyCode)) {<tr><td><a name="l263" href="#l263">263</a><td> opt_heldKeyCode = goog.events.KeyCodes.normalizeKeyCode(opt_heldKeyCode);<tr><td><a name="l264" href="#l264">264</a><td> }<tr><td><a name="l265" href="#l265">265</a><td> if (!opt_shiftKey &amp;&amp;<tr><td><a name="l266" href="#l266">266</a><td> (opt_heldKeyCode == goog.events.KeyCodes.CTRL ||<tr><td><a name="l267" href="#l267">267</a><td> opt_heldKeyCode == goog.events.KeyCodes.ALT ||<tr><td><a name="l268" href="#l268">268</a><td> goog.userAgent.MAC &amp;&amp;<tr><td><a name="l269" href="#l269">269</a><td> opt_heldKeyCode == goog.events.KeyCodes.META)) {<tr><td><a name="l270" href="#l270">270</a><td> return false;<tr><td><a name="l271" href="#l271">271</a><td> }<tr><td><a name="l272" href="#l272">272</a><td><tr><td><a name="l273" href="#l273">273</a><td> // Some keys with Ctrl/Shift do not issue keypress in WEBKIT.<tr><td><a name="l274" href="#l274">274</a><td> if (goog.userAgent.WEBKIT &amp;&amp; opt_ctrlKey &amp;&amp; opt_shiftKey) {<tr><td><a name="l275" href="#l275">275</a><td> switch (keyCode) {<tr><td><a name="l276" href="#l276">276</a><td> case goog.events.KeyCodes.BACKSLASH:<tr><td><a name="l277" href="#l277">277</a><td> case goog.events.KeyCodes.OPEN_SQUARE_BRACKET:<tr><td><a name="l278" href="#l278">278</a><td> case goog.events.KeyCodes.CLOSE_SQUARE_BRACKET:<tr><td><a name="l279" href="#l279">279</a><td> case goog.events.KeyCodes.TILDE:<tr><td><a name="l280" href="#l280">280</a><td> case goog.events.KeyCodes.SEMICOLON:<tr><td><a name="l281" href="#l281">281</a><td> case goog.events.KeyCodes.DASH:<tr><td><a name="l282" href="#l282">282</a><td> case goog.events.KeyCodes.EQUALS:<tr><td><a name="l283" href="#l283">283</a><td> case goog.events.KeyCodes.COMMA:<tr><td><a name="l284" href="#l284">284</a><td> case goog.events.KeyCodes.PERIOD:<tr><td><a name="l285" href="#l285">285</a><td> case goog.events.KeyCodes.SLASH:<tr><td><a name="l286" href="#l286">286</a><td> case goog.events.KeyCodes.APOSTROPHE:<tr><td><a name="l287" href="#l287">287</a><td> case goog.events.KeyCodes.SINGLE_QUOTE:<tr><td><a name="l288" href="#l288">288</a><td> return false;<tr><td><a name="l289" href="#l289">289</a><td> }<tr><td><a name="l290" href="#l290">290</a><td> }<tr><td><a name="l291" href="#l291">291</a><td><tr><td><a name="l292" href="#l292">292</a><td> // When Ctrl+&lt;somekey&gt; is held in IE, it only fires a keypress once, but it<tr><td><a name="l293" href="#l293">293</a><td> // continues to fire keydown events as the event repeats.<tr><td><a name="l294" href="#l294">294</a><td> if (goog.userAgent.IE &amp;&amp; opt_ctrlKey &amp;&amp; opt_heldKeyCode == keyCode) {<tr><td><a name="l295" href="#l295">295</a><td> return false;<tr><td><a name="l296" href="#l296">296</a><td> }<tr><td><a name="l297" href="#l297">297</a><td><tr><td><a name="l298" href="#l298">298</a><td> switch (keyCode) {<tr><td><a name="l299" href="#l299">299</a><td> case goog.events.KeyCodes.ENTER:<tr><td><a name="l300" href="#l300">300</a><td> return true;<tr><td><a name="l301" href="#l301">301</a><td> case goog.events.KeyCodes.ESC:<tr><td><a name="l302" href="#l302">302</a><td> return !goog.userAgent.WEBKIT;<tr><td><a name="l303" href="#l303">303</a><td> }<tr><td><a name="l304" href="#l304">304</a><td><tr><td><a name="l305" href="#l305">305</a><td> return goog.events.KeyCodes.isCharacterKey(keyCode);<tr><td><a name="l306" href="#l306">306</a><td>};<tr><td><a name="l307" href="#l307">307</a><td><tr><td><a name="l308" href="#l308">308</a><td><tr><td><a name="l309" href="#l309">309</a><td>/**<tr><td><a name="l310" href="#l310">310</a><td> * Returns true if the key produces a character.<tr><td><a name="l311" href="#l311">311</a><td> * This does not cover characters on non-US keyboards (Russian, Hebrew, etc.).<tr><td><a name="l312" href="#l312">312</a><td> *<tr><td><a name="l313" href="#l313">313</a><td> * @param {number} keyCode A key code.<tr><td><a name="l314" href="#l314">314</a><td> * @return {boolean} Whether it&#39;s a character key.<tr><td><a name="l315" href="#l315">315</a><td> */<tr><td><a name="l316" href="#l316">316</a><td>goog.events.KeyCodes.isCharacterKey = function(keyCode) {<tr><td><a name="l317" href="#l317">317</a><td> if (keyCode &gt;= goog.events.KeyCodes.ZERO &amp;&amp;<tr><td><a name="l318" href="#l318">318</a><td> keyCode &lt;= goog.events.KeyCodes.NINE) {<tr><td><a name="l319" href="#l319">319</a><td> return true;<tr><td><a name="l320" href="#l320">320</a><td> }<tr><td><a name="l321" href="#l321">321</a><td><tr><td><a name="l322" href="#l322">322</a><td> if (keyCode &gt;= goog.events.KeyCodes.NUM_ZERO &amp;&amp;<tr><td><a name="l323" href="#l323">323</a><td> keyCode &lt;= goog.events.KeyCodes.NUM_MULTIPLY) {<tr><td><a name="l324" href="#l324">324</a><td> return true;<tr><td><a name="l325" href="#l325">325</a><td> }<tr><td><a name="l326" href="#l326">326</a><td><tr><td><a name="l327" href="#l327">327</a><td> if (keyCode &gt;= goog.events.KeyCodes.A &amp;&amp;<tr><td><a name="l328" href="#l328">328</a><td> keyCode &lt;= goog.events.KeyCodes.Z) {<tr><td><a name="l329" href="#l329">329</a><td> return true;<tr><td><a name="l330" href="#l330">330</a><td> }<tr><td><a name="l331" href="#l331">331</a><td><tr><td><a name="l332" href="#l332">332</a><td> // Safari sends zero key code for non-latin characters.<tr><td><a name="l333" href="#l333">333</a><td> if (goog.userAgent.WEBKIT &amp;&amp; keyCode == 0) {<tr><td><a name="l334" href="#l334">334</a><td> return true;<tr><td><a name="l335" href="#l335">335</a><td> }<tr><td><a name="l336" href="#l336">336</a><td><tr><td><a name="l337" href="#l337">337</a><td> switch (keyCode) {<tr><td><a name="l338" href="#l338">338</a><td> case goog.events.KeyCodes.SPACE:<tr><td><a name="l339" href="#l339">339</a><td> case goog.events.KeyCodes.QUESTION_MARK:<tr><td><a name="l340" href="#l340">340</a><td> case goog.events.KeyCodes.NUM_PLUS:<tr><td><a name="l341" href="#l341">341</a><td> case goog.events.KeyCodes.NUM_MINUS:<tr><td><a name="l342" href="#l342">342</a><td> case goog.events.KeyCodes.NUM_PERIOD:<tr><td><a name="l343" href="#l343">343</a><td> case goog.events.KeyCodes.NUM_DIVISION:<tr><td><a name="l344" href="#l344">344</a><td> case goog.events.KeyCodes.SEMICOLON:<tr><td><a name="l345" href="#l345">345</a><td> case goog.events.KeyCodes.FF_SEMICOLON:<tr><td><a name="l346" href="#l346">346</a><td> case goog.events.KeyCodes.DASH:<tr><td><a name="l347" href="#l347">347</a><td> case goog.events.KeyCodes.EQUALS:<tr><td><a name="l348" href="#l348">348</a><td> case goog.events.KeyCodes.FF_EQUALS:<tr><td><a name="l349" href="#l349">349</a><td> case goog.events.KeyCodes.COMMA:<tr><td><a name="l350" href="#l350">350</a><td> case goog.events.KeyCodes.PERIOD:<tr><td><a name="l351" href="#l351">351</a><td> case goog.events.KeyCodes.SLASH:<tr><td><a name="l352" href="#l352">352</a><td> case goog.events.KeyCodes.APOSTROPHE:<tr><td><a name="l353" href="#l353">353</a><td> case goog.events.KeyCodes.SINGLE_QUOTE:<tr><td><a name="l354" href="#l354">354</a><td> case goog.events.KeyCodes.OPEN_SQUARE_BRACKET:<tr><td><a name="l355" href="#l355">355</a><td> case goog.events.KeyCodes.BACKSLASH:<tr><td><a name="l356" href="#l356">356</a><td> case goog.events.KeyCodes.CLOSE_SQUARE_BRACKET:<tr><td><a name="l357" href="#l357">357</a><td> return true;<tr><td><a name="l358" href="#l358">358</a><td> default:<tr><td><a name="l359" href="#l359">359</a><td> return false;<tr><td><a name="l360" href="#l360">360</a><td> }<tr><td><a name="l361" href="#l361">361</a><td>};<tr><td><a name="l362" href="#l362">362</a><td><tr><td><a name="l363" href="#l363">363</a><td><tr><td><a name="l364" href="#l364">364</a><td>/**<tr><td><a name="l365" href="#l365">365</a><td> * Normalizes key codes from OS/Browser-specific value to the general one.<tr><td><a name="l366" href="#l366">366</a><td> * @param {number} keyCode The native key code.<tr><td><a name="l367" href="#l367">367</a><td> * @return {number} The normalized key code.<tr><td><a name="l368" href="#l368">368</a><td> */<tr><td><a name="l369" href="#l369">369</a><td>goog.events.KeyCodes.normalizeKeyCode = function(keyCode) {<tr><td><a name="l370" href="#l370">370</a><td> if (goog.userAgent.GECKO) {<tr><td><a name="l371" href="#l371">371</a><td> return goog.events.KeyCodes.normalizeGeckoKeyCode(keyCode);<tr><td><a name="l372" href="#l372">372</a><td> } else if (goog.userAgent.MAC &amp;&amp; goog.userAgent.WEBKIT) {<tr><td><a name="l373" href="#l373">373</a><td> return goog.events.KeyCodes.normalizeMacWebKitKeyCode(keyCode);<tr><td><a name="l374" href="#l374">374</a><td> } else {<tr><td><a name="l375" href="#l375">375</a><td> return keyCode;<tr><td><a name="l376" href="#l376">376</a><td> }<tr><td><a name="l377" href="#l377">377</a><td>};<tr><td><a name="l378" href="#l378">378</a><td><tr><td><a name="l379" href="#l379">379</a><td><tr><td><a name="l380" href="#l380">380</a><td>/**<tr><td><a name="l381" href="#l381">381</a><td> * Normalizes key codes from their Gecko-specific value to the general one.<tr><td><a name="l382" href="#l382">382</a><td> * @param {number} keyCode The native key code.<tr><td><a name="l383" href="#l383">383</a><td> * @return {number} The normalized key code.<tr><td><a name="l384" href="#l384">384</a><td> */<tr><td><a name="l385" href="#l385">385</a><td>goog.events.KeyCodes.normalizeGeckoKeyCode = function(keyCode) {<tr><td><a name="l386" href="#l386">386</a><td> switch (keyCode) {<tr><td><a name="l387" href="#l387">387</a><td> case goog.events.KeyCodes.FF_EQUALS:<tr><td><a name="l388" href="#l388">388</a><td> return goog.events.KeyCodes.EQUALS;<tr><td><a name="l389" href="#l389">389</a><td> case goog.events.KeyCodes.FF_SEMICOLON:<tr><td><a name="l390" href="#l390">390</a><td> return goog.events.KeyCodes.SEMICOLON;<tr><td><a name="l391" href="#l391">391</a><td> case goog.events.KeyCodes.FF_DASH:<tr><td><a name="l392" href="#l392">392</a><td> return goog.events.KeyCodes.DASH;<tr><td><a name="l393" href="#l393">393</a><td> case goog.events.KeyCodes.MAC_FF_META:<tr><td><a name="l394" href="#l394">394</a><td> return goog.events.KeyCodes.META;<tr><td><a name="l395" href="#l395">395</a><td> case goog.events.KeyCodes.WIN_KEY_FF_LINUX:<tr><td><a name="l396" href="#l396">396</a><td> return goog.events.KeyCodes.WIN_KEY;<tr><td><a name="l397" href="#l397">397</a><td> default:<tr><td><a name="l398" href="#l398">398</a><td> return keyCode;<tr><td><a name="l399" href="#l399">399</a><td> }<tr><td><a name="l400" href="#l400">400</a><td>};<tr><td><a name="l401" href="#l401">401</a><td><tr><td><a name="l402" href="#l402">402</a><td><tr><td><a name="l403" href="#l403">403</a><td>/**<tr><td><a name="l404" href="#l404">404</a><td> * Normalizes key codes from their Mac WebKit-specific value to the general one.<tr><td><a name="l405" href="#l405">405</a><td> * @param {number} keyCode The native key code.<tr><td><a name="l406" href="#l406">406</a><td> * @return {number} The normalized key code.<tr><td><a name="l407" href="#l407">407</a><td> */<tr><td><a name="l408" href="#l408">408</a><td>goog.events.KeyCodes.normalizeMacWebKitKeyCode = function(keyCode) {<tr><td><a name="l409" href="#l409">409</a><td> switch (keyCode) {<tr><td><a name="l410" href="#l410">410</a><td> case goog.events.KeyCodes.MAC_WK_CMD_RIGHT: // 93<tr><td><a name="l411" href="#l411">411</a><td> return goog.events.KeyCodes.META; // 91<tr><td><a name="l412" href="#l412">412</a><td> default:<tr><td><a name="l413" href="#l413">413</a><td> return keyCode;<tr><td><a name="l414" href="#l414">414</a><td> }<tr><td><a name="l415" href="#l415">415</a><td>};</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../../types.js"></script><script src="../../../../dossier.js"></script>
1
+ <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>keycodes.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/events/keycodes.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2006 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Constant declarations for common key codes.<tr><td><a name="l17" href="#l17">17</a><td> *<tr><td><a name="l18" href="#l18">18</a><td> * @author eae@google.com (Emil A Eklund)<tr><td><a name="l19" href="#l19">19</a><td> * @see ../demos/keyhandler.html<tr><td><a name="l20" href="#l20">20</a><td> */<tr><td><a name="l21" href="#l21">21</a><td><tr><td><a name="l22" href="#l22">22</a><td>goog.provide(&#39;goog.events.KeyCodes&#39;);<tr><td><a name="l23" href="#l23">23</a><td><tr><td><a name="l24" href="#l24">24</a><td>goog.require(&#39;goog.userAgent&#39;);<tr><td><a name="l25" href="#l25">25</a><td><tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td>/**<tr><td><a name="l28" href="#l28">28</a><td> * Key codes for common characters.<tr><td><a name="l29" href="#l29">29</a><td> *<tr><td><a name="l30" href="#l30">30</a><td> * This list is not localized and therefore some of the key codes are not<tr><td><a name="l31" href="#l31">31</a><td> * correct for non US keyboard layouts. See comments below.<tr><td><a name="l32" href="#l32">32</a><td> *<tr><td><a name="l33" href="#l33">33</a><td> * @enum {number}<tr><td><a name="l34" href="#l34">34</a><td> */<tr><td><a name="l35" href="#l35">35</a><td>goog.events.KeyCodes = {<tr><td><a name="l36" href="#l36">36</a><td> WIN_KEY_FF_LINUX: 0,<tr><td><a name="l37" href="#l37">37</a><td> MAC_ENTER: 3,<tr><td><a name="l38" href="#l38">38</a><td> BACKSPACE: 8,<tr><td><a name="l39" href="#l39">39</a><td> TAB: 9,<tr><td><a name="l40" href="#l40">40</a><td> NUM_CENTER: 12, // NUMLOCK on FF/Safari Mac<tr><td><a name="l41" href="#l41">41</a><td> ENTER: 13,<tr><td><a name="l42" href="#l42">42</a><td> SHIFT: 16,<tr><td><a name="l43" href="#l43">43</a><td> CTRL: 17,<tr><td><a name="l44" href="#l44">44</a><td> ALT: 18,<tr><td><a name="l45" href="#l45">45</a><td> PAUSE: 19,<tr><td><a name="l46" href="#l46">46</a><td> CAPS_LOCK: 20,<tr><td><a name="l47" href="#l47">47</a><td> ESC: 27,<tr><td><a name="l48" href="#l48">48</a><td> SPACE: 32,<tr><td><a name="l49" href="#l49">49</a><td> PAGE_UP: 33, // also NUM_NORTH_EAST<tr><td><a name="l50" href="#l50">50</a><td> PAGE_DOWN: 34, // also NUM_SOUTH_EAST<tr><td><a name="l51" href="#l51">51</a><td> END: 35, // also NUM_SOUTH_WEST<tr><td><a name="l52" href="#l52">52</a><td> HOME: 36, // also NUM_NORTH_WEST<tr><td><a name="l53" href="#l53">53</a><td> LEFT: 37, // also NUM_WEST<tr><td><a name="l54" href="#l54">54</a><td> UP: 38, // also NUM_NORTH<tr><td><a name="l55" href="#l55">55</a><td> RIGHT: 39, // also NUM_EAST<tr><td><a name="l56" href="#l56">56</a><td> DOWN: 40, // also NUM_SOUTH<tr><td><a name="l57" href="#l57">57</a><td> PRINT_SCREEN: 44,<tr><td><a name="l58" href="#l58">58</a><td> INSERT: 45, // also NUM_INSERT<tr><td><a name="l59" href="#l59">59</a><td> DELETE: 46, // also NUM_DELETE<tr><td><a name="l60" href="#l60">60</a><td> ZERO: 48,<tr><td><a name="l61" href="#l61">61</a><td> ONE: 49,<tr><td><a name="l62" href="#l62">62</a><td> TWO: 50,<tr><td><a name="l63" href="#l63">63</a><td> THREE: 51,<tr><td><a name="l64" href="#l64">64</a><td> FOUR: 52,<tr><td><a name="l65" href="#l65">65</a><td> FIVE: 53,<tr><td><a name="l66" href="#l66">66</a><td> SIX: 54,<tr><td><a name="l67" href="#l67">67</a><td> SEVEN: 55,<tr><td><a name="l68" href="#l68">68</a><td> EIGHT: 56,<tr><td><a name="l69" href="#l69">69</a><td> NINE: 57,<tr><td><a name="l70" href="#l70">70</a><td> FF_SEMICOLON: 59, // Firefox (Gecko) fires this for semicolon instead of 186<tr><td><a name="l71" href="#l71">71</a><td> FF_EQUALS: 61, // Firefox (Gecko) fires this for equals instead of 187<tr><td><a name="l72" href="#l72">72</a><td> FF_DASH: 173, // Firefox (Gecko) fires this for dash instead of 189<tr><td><a name="l73" href="#l73">73</a><td> QUESTION_MARK: 63, // needs localization<tr><td><a name="l74" href="#l74">74</a><td> A: 65,<tr><td><a name="l75" href="#l75">75</a><td> B: 66,<tr><td><a name="l76" href="#l76">76</a><td> C: 67,<tr><td><a name="l77" href="#l77">77</a><td> D: 68,<tr><td><a name="l78" href="#l78">78</a><td> E: 69,<tr><td><a name="l79" href="#l79">79</a><td> F: 70,<tr><td><a name="l80" href="#l80">80</a><td> G: 71,<tr><td><a name="l81" href="#l81">81</a><td> H: 72,<tr><td><a name="l82" href="#l82">82</a><td> I: 73,<tr><td><a name="l83" href="#l83">83</a><td> J: 74,<tr><td><a name="l84" href="#l84">84</a><td> K: 75,<tr><td><a name="l85" href="#l85">85</a><td> L: 76,<tr><td><a name="l86" href="#l86">86</a><td> M: 77,<tr><td><a name="l87" href="#l87">87</a><td> N: 78,<tr><td><a name="l88" href="#l88">88</a><td> O: 79,<tr><td><a name="l89" href="#l89">89</a><td> P: 80,<tr><td><a name="l90" href="#l90">90</a><td> Q: 81,<tr><td><a name="l91" href="#l91">91</a><td> R: 82,<tr><td><a name="l92" href="#l92">92</a><td> S: 83,<tr><td><a name="l93" href="#l93">93</a><td> T: 84,<tr><td><a name="l94" href="#l94">94</a><td> U: 85,<tr><td><a name="l95" href="#l95">95</a><td> V: 86,<tr><td><a name="l96" href="#l96">96</a><td> W: 87,<tr><td><a name="l97" href="#l97">97</a><td> X: 88,<tr><td><a name="l98" href="#l98">98</a><td> Y: 89,<tr><td><a name="l99" href="#l99">99</a><td> Z: 90,<tr><td><a name="l100" href="#l100">100</a><td> META: 91, // WIN_KEY_LEFT<tr><td><a name="l101" href="#l101">101</a><td> WIN_KEY_RIGHT: 92,<tr><td><a name="l102" href="#l102">102</a><td> CONTEXT_MENU: 93,<tr><td><a name="l103" href="#l103">103</a><td> NUM_ZERO: 96,<tr><td><a name="l104" href="#l104">104</a><td> NUM_ONE: 97,<tr><td><a name="l105" href="#l105">105</a><td> NUM_TWO: 98,<tr><td><a name="l106" href="#l106">106</a><td> NUM_THREE: 99,<tr><td><a name="l107" href="#l107">107</a><td> NUM_FOUR: 100,<tr><td><a name="l108" href="#l108">108</a><td> NUM_FIVE: 101,<tr><td><a name="l109" href="#l109">109</a><td> NUM_SIX: 102,<tr><td><a name="l110" href="#l110">110</a><td> NUM_SEVEN: 103,<tr><td><a name="l111" href="#l111">111</a><td> NUM_EIGHT: 104,<tr><td><a name="l112" href="#l112">112</a><td> NUM_NINE: 105,<tr><td><a name="l113" href="#l113">113</a><td> NUM_MULTIPLY: 106,<tr><td><a name="l114" href="#l114">114</a><td> NUM_PLUS: 107,<tr><td><a name="l115" href="#l115">115</a><td> NUM_MINUS: 109,<tr><td><a name="l116" href="#l116">116</a><td> NUM_PERIOD: 110,<tr><td><a name="l117" href="#l117">117</a><td> NUM_DIVISION: 111,<tr><td><a name="l118" href="#l118">118</a><td> F1: 112,<tr><td><a name="l119" href="#l119">119</a><td> F2: 113,<tr><td><a name="l120" href="#l120">120</a><td> F3: 114,<tr><td><a name="l121" href="#l121">121</a><td> F4: 115,<tr><td><a name="l122" href="#l122">122</a><td> F5: 116,<tr><td><a name="l123" href="#l123">123</a><td> F6: 117,<tr><td><a name="l124" href="#l124">124</a><td> F7: 118,<tr><td><a name="l125" href="#l125">125</a><td> F8: 119,<tr><td><a name="l126" href="#l126">126</a><td> F9: 120,<tr><td><a name="l127" href="#l127">127</a><td> F10: 121,<tr><td><a name="l128" href="#l128">128</a><td> F11: 122,<tr><td><a name="l129" href="#l129">129</a><td> F12: 123,<tr><td><a name="l130" href="#l130">130</a><td> NUMLOCK: 144,<tr><td><a name="l131" href="#l131">131</a><td> SCROLL_LOCK: 145,<tr><td><a name="l132" href="#l132">132</a><td><tr><td><a name="l133" href="#l133">133</a><td> // OS-specific media keys like volume controls and browser controls.<tr><td><a name="l134" href="#l134">134</a><td> FIRST_MEDIA_KEY: 166,<tr><td><a name="l135" href="#l135">135</a><td> LAST_MEDIA_KEY: 183,<tr><td><a name="l136" href="#l136">136</a><td><tr><td><a name="l137" href="#l137">137</a><td> SEMICOLON: 186, // needs localization<tr><td><a name="l138" href="#l138">138</a><td> DASH: 189, // needs localization<tr><td><a name="l139" href="#l139">139</a><td> EQUALS: 187, // needs localization<tr><td><a name="l140" href="#l140">140</a><td> COMMA: 188, // needs localization<tr><td><a name="l141" href="#l141">141</a><td> PERIOD: 190, // needs localization<tr><td><a name="l142" href="#l142">142</a><td> SLASH: 191, // needs localization<tr><td><a name="l143" href="#l143">143</a><td> APOSTROPHE: 192, // needs localization<tr><td><a name="l144" href="#l144">144</a><td> TILDE: 192, // needs localization<tr><td><a name="l145" href="#l145">145</a><td> SINGLE_QUOTE: 222, // needs localization<tr><td><a name="l146" href="#l146">146</a><td> OPEN_SQUARE_BRACKET: 219, // needs localization<tr><td><a name="l147" href="#l147">147</a><td> BACKSLASH: 220, // needs localization<tr><td><a name="l148" href="#l148">148</a><td> CLOSE_SQUARE_BRACKET: 221, // needs localization<tr><td><a name="l149" href="#l149">149</a><td> WIN_KEY: 224,<tr><td><a name="l150" href="#l150">150</a><td> MAC_FF_META: 224, // Firefox (Gecko) fires this for the meta key instead of 91<tr><td><a name="l151" href="#l151">151</a><td> MAC_WK_CMD_LEFT: 91, // WebKit Left Command key fired, same as META<tr><td><a name="l152" href="#l152">152</a><td> MAC_WK_CMD_RIGHT: 93, // WebKit Right Command key fired, different from META<tr><td><a name="l153" href="#l153">153</a><td> WIN_IME: 229,<tr><td><a name="l154" href="#l154">154</a><td><tr><td><a name="l155" href="#l155">155</a><td> // We&#39;ve seen users whose machines fire this keycode at regular one<tr><td><a name="l156" href="#l156">156</a><td> // second intervals. The common thread among these users is that<tr><td><a name="l157" href="#l157">157</a><td> // they&#39;re all using Dell Inspiron laptops, so we suspect that this<tr><td><a name="l158" href="#l158">158</a><td> // indicates a hardware/bios problem.<tr><td><a name="l159" href="#l159">159</a><td> // http://en.community.dell.com/support-forums/laptop/f/3518/p/19285957/19523128.aspx<tr><td><a name="l160" href="#l160">160</a><td> PHANTOM: 255<tr><td><a name="l161" href="#l161">161</a><td>};<tr><td><a name="l162" href="#l162">162</a><td><tr><td><a name="l163" href="#l163">163</a><td><tr><td><a name="l164" href="#l164">164</a><td>/**<tr><td><a name="l165" href="#l165">165</a><td> * Returns true if the event contains a text modifying key.<tr><td><a name="l166" href="#l166">166</a><td> * @param {goog.events.BrowserEvent} e A key event.<tr><td><a name="l167" href="#l167">167</a><td> * @return {boolean} Whether it&#39;s a text modifying key.<tr><td><a name="l168" href="#l168">168</a><td> */<tr><td><a name="l169" href="#l169">169</a><td>goog.events.KeyCodes.isTextModifyingKeyEvent = function(e) {<tr><td><a name="l170" href="#l170">170</a><td> if (e.altKey &amp;&amp; !e.ctrlKey ||<tr><td><a name="l171" href="#l171">171</a><td> e.metaKey ||<tr><td><a name="l172" href="#l172">172</a><td> // Function keys don&#39;t generate text<tr><td><a name="l173" href="#l173">173</a><td> e.keyCode &gt;= goog.events.KeyCodes.F1 &amp;&amp;<tr><td><a name="l174" href="#l174">174</a><td> e.keyCode &lt;= goog.events.KeyCodes.F12) {<tr><td><a name="l175" href="#l175">175</a><td> return false;<tr><td><a name="l176" href="#l176">176</a><td> }<tr><td><a name="l177" href="#l177">177</a><td><tr><td><a name="l178" href="#l178">178</a><td> // The following keys are quite harmless, even in combination with<tr><td><a name="l179" href="#l179">179</a><td> // CTRL, ALT or SHIFT.<tr><td><a name="l180" href="#l180">180</a><td> switch (e.keyCode) {<tr><td><a name="l181" href="#l181">181</a><td> case goog.events.KeyCodes.ALT:<tr><td><a name="l182" href="#l182">182</a><td> case goog.events.KeyCodes.CAPS_LOCK:<tr><td><a name="l183" href="#l183">183</a><td> case goog.events.KeyCodes.CONTEXT_MENU:<tr><td><a name="l184" href="#l184">184</a><td> case goog.events.KeyCodes.CTRL:<tr><td><a name="l185" href="#l185">185</a><td> case goog.events.KeyCodes.DOWN:<tr><td><a name="l186" href="#l186">186</a><td> case goog.events.KeyCodes.END:<tr><td><a name="l187" href="#l187">187</a><td> case goog.events.KeyCodes.ESC:<tr><td><a name="l188" href="#l188">188</a><td> case goog.events.KeyCodes.HOME:<tr><td><a name="l189" href="#l189">189</a><td> case goog.events.KeyCodes.INSERT:<tr><td><a name="l190" href="#l190">190</a><td> case goog.events.KeyCodes.LEFT:<tr><td><a name="l191" href="#l191">191</a><td> case goog.events.KeyCodes.MAC_FF_META:<tr><td><a name="l192" href="#l192">192</a><td> case goog.events.KeyCodes.META:<tr><td><a name="l193" href="#l193">193</a><td> case goog.events.KeyCodes.NUMLOCK:<tr><td><a name="l194" href="#l194">194</a><td> case goog.events.KeyCodes.NUM_CENTER:<tr><td><a name="l195" href="#l195">195</a><td> case goog.events.KeyCodes.PAGE_DOWN:<tr><td><a name="l196" href="#l196">196</a><td> case goog.events.KeyCodes.PAGE_UP:<tr><td><a name="l197" href="#l197">197</a><td> case goog.events.KeyCodes.PAUSE:<tr><td><a name="l198" href="#l198">198</a><td> case goog.events.KeyCodes.PHANTOM:<tr><td><a name="l199" href="#l199">199</a><td> case goog.events.KeyCodes.PRINT_SCREEN:<tr><td><a name="l200" href="#l200">200</a><td> case goog.events.KeyCodes.RIGHT:<tr><td><a name="l201" href="#l201">201</a><td> case goog.events.KeyCodes.SCROLL_LOCK:<tr><td><a name="l202" href="#l202">202</a><td> case goog.events.KeyCodes.SHIFT:<tr><td><a name="l203" href="#l203">203</a><td> case goog.events.KeyCodes.UP:<tr><td><a name="l204" href="#l204">204</a><td> case goog.events.KeyCodes.WIN_KEY:<tr><td><a name="l205" href="#l205">205</a><td> case goog.events.KeyCodes.WIN_KEY_RIGHT:<tr><td><a name="l206" href="#l206">206</a><td> return false;<tr><td><a name="l207" href="#l207">207</a><td> case goog.events.KeyCodes.WIN_KEY_FF_LINUX:<tr><td><a name="l208" href="#l208">208</a><td> return !goog.userAgent.GECKO;<tr><td><a name="l209" href="#l209">209</a><td> default:<tr><td><a name="l210" href="#l210">210</a><td> return e.keyCode &lt; goog.events.KeyCodes.FIRST_MEDIA_KEY ||<tr><td><a name="l211" href="#l211">211</a><td> e.keyCode &gt; goog.events.KeyCodes.LAST_MEDIA_KEY;<tr><td><a name="l212" href="#l212">212</a><td> }<tr><td><a name="l213" href="#l213">213</a><td>};<tr><td><a name="l214" href="#l214">214</a><td><tr><td><a name="l215" href="#l215">215</a><td><tr><td><a name="l216" href="#l216">216</a><td>/**<tr><td><a name="l217" href="#l217">217</a><td> * Returns true if the key fires a keypress event in the current browser.<tr><td><a name="l218" href="#l218">218</a><td> *<tr><td><a name="l219" href="#l219">219</a><td> * Accoridng to MSDN [1] IE only fires keypress events for the following keys:<tr><td><a name="l220" href="#l220">220</a><td> * - Letters: A - Z (uppercase and lowercase)<tr><td><a name="l221" href="#l221">221</a><td> * - Numerals: 0 - 9<tr><td><a name="l222" href="#l222">222</a><td> * - Symbols: ! @ # $ % ^ &amp; * ( ) _ - + = &lt; [ ] { } , . / ? \ | &#39; ` &quot; ~<tr><td><a name="l223" href="#l223">223</a><td> * - System: ESC, SPACEBAR, ENTER<tr><td><a name="l224" href="#l224">224</a><td> *<tr><td><a name="l225" href="#l225">225</a><td> * That&#39;s not entirely correct though, for instance there&#39;s no distinction<tr><td><a name="l226" href="#l226">226</a><td> * between upper and lower case letters.<tr><td><a name="l227" href="#l227">227</a><td> *<tr><td><a name="l228" href="#l228">228</a><td> * [1] http://msdn2.microsoft.com/en-us/library/ms536939(VS.85).aspx)<tr><td><a name="l229" href="#l229">229</a><td> *<tr><td><a name="l230" href="#l230">230</a><td> * Safari is similar to IE, but does not fire keypress for ESC.<tr><td><a name="l231" href="#l231">231</a><td> *<tr><td><a name="l232" href="#l232">232</a><td> * Additionally, IE6 does not fire keydown or keypress events for letters when<tr><td><a name="l233" href="#l233">233</a><td> * the control or alt keys are held down and the shift key is not. IE7 does<tr><td><a name="l234" href="#l234">234</a><td> * fire keydown in these cases, though, but not keypress.<tr><td><a name="l235" href="#l235">235</a><td> *<tr><td><a name="l236" href="#l236">236</a><td> * @param {number} keyCode A key code.<tr><td><a name="l237" href="#l237">237</a><td> * @param {number=} opt_heldKeyCode Key code of a currently-held key.<tr><td><a name="l238" href="#l238">238</a><td> * @param {boolean=} opt_shiftKey Whether the shift key is held down.<tr><td><a name="l239" href="#l239">239</a><td> * @param {boolean=} opt_ctrlKey Whether the control key is held down.<tr><td><a name="l240" href="#l240">240</a><td> * @param {boolean=} opt_altKey Whether the alt key is held down.<tr><td><a name="l241" href="#l241">241</a><td> * @return {boolean} Whether it&#39;s a key that fires a keypress event.<tr><td><a name="l242" href="#l242">242</a><td> */<tr><td><a name="l243" href="#l243">243</a><td>goog.events.KeyCodes.firesKeyPressEvent = function(keyCode, opt_heldKeyCode,<tr><td><a name="l244" href="#l244">244</a><td> opt_shiftKey, opt_ctrlKey, opt_altKey) {<tr><td><a name="l245" href="#l245">245</a><td> if (!goog.userAgent.IE &amp;&amp;<tr><td><a name="l246" href="#l246">246</a><td> !(goog.userAgent.WEBKIT &amp;&amp; goog.userAgent.isVersionOrHigher(&#39;525&#39;))) {<tr><td><a name="l247" href="#l247">247</a><td> return true;<tr><td><a name="l248" href="#l248">248</a><td> }<tr><td><a name="l249" href="#l249">249</a><td><tr><td><a name="l250" href="#l250">250</a><td> if (goog.userAgent.MAC &amp;&amp; opt_altKey) {<tr><td><a name="l251" href="#l251">251</a><td> return goog.events.KeyCodes.isCharacterKey(keyCode);<tr><td><a name="l252" href="#l252">252</a><td> }<tr><td><a name="l253" href="#l253">253</a><td><tr><td><a name="l254" href="#l254">254</a><td> // Alt but not AltGr which is represented as Alt+Ctrl.<tr><td><a name="l255" href="#l255">255</a><td> if (opt_altKey &amp;&amp; !opt_ctrlKey) {<tr><td><a name="l256" href="#l256">256</a><td> return false;<tr><td><a name="l257" href="#l257">257</a><td> }<tr><td><a name="l258" href="#l258">258</a><td><tr><td><a name="l259" href="#l259">259</a><td> // Saves Ctrl or Alt + key for IE and WebKit 525+, which won&#39;t fire keypress.<tr><td><a name="l260" href="#l260">260</a><td> // Non-IE browsers and WebKit prior to 525 won&#39;t get this far so no need to<tr><td><a name="l261" href="#l261">261</a><td> // check the user agent.<tr><td><a name="l262" href="#l262">262</a><td> if (goog.isNumber(opt_heldKeyCode)) {<tr><td><a name="l263" href="#l263">263</a><td> opt_heldKeyCode = goog.events.KeyCodes.normalizeKeyCode(opt_heldKeyCode);<tr><td><a name="l264" href="#l264">264</a><td> }<tr><td><a name="l265" href="#l265">265</a><td> if (!opt_shiftKey &amp;&amp;<tr><td><a name="l266" href="#l266">266</a><td> (opt_heldKeyCode == goog.events.KeyCodes.CTRL ||<tr><td><a name="l267" href="#l267">267</a><td> opt_heldKeyCode == goog.events.KeyCodes.ALT ||<tr><td><a name="l268" href="#l268">268</a><td> goog.userAgent.MAC &amp;&amp;<tr><td><a name="l269" href="#l269">269</a><td> opt_heldKeyCode == goog.events.KeyCodes.META)) {<tr><td><a name="l270" href="#l270">270</a><td> return false;<tr><td><a name="l271" href="#l271">271</a><td> }<tr><td><a name="l272" href="#l272">272</a><td><tr><td><a name="l273" href="#l273">273</a><td> // Some keys with Ctrl/Shift do not issue keypress in WEBKIT.<tr><td><a name="l274" href="#l274">274</a><td> if (goog.userAgent.WEBKIT &amp;&amp; opt_ctrlKey &amp;&amp; opt_shiftKey) {<tr><td><a name="l275" href="#l275">275</a><td> switch (keyCode) {<tr><td><a name="l276" href="#l276">276</a><td> case goog.events.KeyCodes.BACKSLASH:<tr><td><a name="l277" href="#l277">277</a><td> case goog.events.KeyCodes.OPEN_SQUARE_BRACKET:<tr><td><a name="l278" href="#l278">278</a><td> case goog.events.KeyCodes.CLOSE_SQUARE_BRACKET:<tr><td><a name="l279" href="#l279">279</a><td> case goog.events.KeyCodes.TILDE:<tr><td><a name="l280" href="#l280">280</a><td> case goog.events.KeyCodes.SEMICOLON:<tr><td><a name="l281" href="#l281">281</a><td> case goog.events.KeyCodes.DASH:<tr><td><a name="l282" href="#l282">282</a><td> case goog.events.KeyCodes.EQUALS:<tr><td><a name="l283" href="#l283">283</a><td> case goog.events.KeyCodes.COMMA:<tr><td><a name="l284" href="#l284">284</a><td> case goog.events.KeyCodes.PERIOD:<tr><td><a name="l285" href="#l285">285</a><td> case goog.events.KeyCodes.SLASH:<tr><td><a name="l286" href="#l286">286</a><td> case goog.events.KeyCodes.APOSTROPHE:<tr><td><a name="l287" href="#l287">287</a><td> case goog.events.KeyCodes.SINGLE_QUOTE:<tr><td><a name="l288" href="#l288">288</a><td> return false;<tr><td><a name="l289" href="#l289">289</a><td> }<tr><td><a name="l290" href="#l290">290</a><td> }<tr><td><a name="l291" href="#l291">291</a><td><tr><td><a name="l292" href="#l292">292</a><td> // When Ctrl+&lt;somekey&gt; is held in IE, it only fires a keypress once, but it<tr><td><a name="l293" href="#l293">293</a><td> // continues to fire keydown events as the event repeats.<tr><td><a name="l294" href="#l294">294</a><td> if (goog.userAgent.IE &amp;&amp; opt_ctrlKey &amp;&amp; opt_heldKeyCode == keyCode) {<tr><td><a name="l295" href="#l295">295</a><td> return false;<tr><td><a name="l296" href="#l296">296</a><td> }<tr><td><a name="l297" href="#l297">297</a><td><tr><td><a name="l298" href="#l298">298</a><td> switch (keyCode) {<tr><td><a name="l299" href="#l299">299</a><td> case goog.events.KeyCodes.ENTER:<tr><td><a name="l300" href="#l300">300</a><td> return true;<tr><td><a name="l301" href="#l301">301</a><td> case goog.events.KeyCodes.ESC:<tr><td><a name="l302" href="#l302">302</a><td> return !goog.userAgent.WEBKIT;<tr><td><a name="l303" href="#l303">303</a><td> }<tr><td><a name="l304" href="#l304">304</a><td><tr><td><a name="l305" href="#l305">305</a><td> return goog.events.KeyCodes.isCharacterKey(keyCode);<tr><td><a name="l306" href="#l306">306</a><td>};<tr><td><a name="l307" href="#l307">307</a><td><tr><td><a name="l308" href="#l308">308</a><td><tr><td><a name="l309" href="#l309">309</a><td>/**<tr><td><a name="l310" href="#l310">310</a><td> * Returns true if the key produces a character.<tr><td><a name="l311" href="#l311">311</a><td> * This does not cover characters on non-US keyboards (Russian, Hebrew, etc.).<tr><td><a name="l312" href="#l312">312</a><td> *<tr><td><a name="l313" href="#l313">313</a><td> * @param {number} keyCode A key code.<tr><td><a name="l314" href="#l314">314</a><td> * @return {boolean} Whether it&#39;s a character key.<tr><td><a name="l315" href="#l315">315</a><td> */<tr><td><a name="l316" href="#l316">316</a><td>goog.events.KeyCodes.isCharacterKey = function(keyCode) {<tr><td><a name="l317" href="#l317">317</a><td> if (keyCode &gt;= goog.events.KeyCodes.ZERO &amp;&amp;<tr><td><a name="l318" href="#l318">318</a><td> keyCode &lt;= goog.events.KeyCodes.NINE) {<tr><td><a name="l319" href="#l319">319</a><td> return true;<tr><td><a name="l320" href="#l320">320</a><td> }<tr><td><a name="l321" href="#l321">321</a><td><tr><td><a name="l322" href="#l322">322</a><td> if (keyCode &gt;= goog.events.KeyCodes.NUM_ZERO &amp;&amp;<tr><td><a name="l323" href="#l323">323</a><td> keyCode &lt;= goog.events.KeyCodes.NUM_MULTIPLY) {<tr><td><a name="l324" href="#l324">324</a><td> return true;<tr><td><a name="l325" href="#l325">325</a><td> }<tr><td><a name="l326" href="#l326">326</a><td><tr><td><a name="l327" href="#l327">327</a><td> if (keyCode &gt;= goog.events.KeyCodes.A &amp;&amp;<tr><td><a name="l328" href="#l328">328</a><td> keyCode &lt;= goog.events.KeyCodes.Z) {<tr><td><a name="l329" href="#l329">329</a><td> return true;<tr><td><a name="l330" href="#l330">330</a><td> }<tr><td><a name="l331" href="#l331">331</a><td><tr><td><a name="l332" href="#l332">332</a><td> // Safari sends zero key code for non-latin characters.<tr><td><a name="l333" href="#l333">333</a><td> if (goog.userAgent.WEBKIT &amp;&amp; keyCode == 0) {<tr><td><a name="l334" href="#l334">334</a><td> return true;<tr><td><a name="l335" href="#l335">335</a><td> }<tr><td><a name="l336" href="#l336">336</a><td><tr><td><a name="l337" href="#l337">337</a><td> switch (keyCode) {<tr><td><a name="l338" href="#l338">338</a><td> case goog.events.KeyCodes.SPACE:<tr><td><a name="l339" href="#l339">339</a><td> case goog.events.KeyCodes.QUESTION_MARK:<tr><td><a name="l340" href="#l340">340</a><td> case goog.events.KeyCodes.NUM_PLUS:<tr><td><a name="l341" href="#l341">341</a><td> case goog.events.KeyCodes.NUM_MINUS:<tr><td><a name="l342" href="#l342">342</a><td> case goog.events.KeyCodes.NUM_PERIOD:<tr><td><a name="l343" href="#l343">343</a><td> case goog.events.KeyCodes.NUM_DIVISION:<tr><td><a name="l344" href="#l344">344</a><td> case goog.events.KeyCodes.SEMICOLON:<tr><td><a name="l345" href="#l345">345</a><td> case goog.events.KeyCodes.FF_SEMICOLON:<tr><td><a name="l346" href="#l346">346</a><td> case goog.events.KeyCodes.DASH:<tr><td><a name="l347" href="#l347">347</a><td> case goog.events.KeyCodes.EQUALS:<tr><td><a name="l348" href="#l348">348</a><td> case goog.events.KeyCodes.FF_EQUALS:<tr><td><a name="l349" href="#l349">349</a><td> case goog.events.KeyCodes.COMMA:<tr><td><a name="l350" href="#l350">350</a><td> case goog.events.KeyCodes.PERIOD:<tr><td><a name="l351" href="#l351">351</a><td> case goog.events.KeyCodes.SLASH:<tr><td><a name="l352" href="#l352">352</a><td> case goog.events.KeyCodes.APOSTROPHE:<tr><td><a name="l353" href="#l353">353</a><td> case goog.events.KeyCodes.SINGLE_QUOTE:<tr><td><a name="l354" href="#l354">354</a><td> case goog.events.KeyCodes.OPEN_SQUARE_BRACKET:<tr><td><a name="l355" href="#l355">355</a><td> case goog.events.KeyCodes.BACKSLASH:<tr><td><a name="l356" href="#l356">356</a><td> case goog.events.KeyCodes.CLOSE_SQUARE_BRACKET:<tr><td><a name="l357" href="#l357">357</a><td> return true;<tr><td><a name="l358" href="#l358">358</a><td> default:<tr><td><a name="l359" href="#l359">359</a><td> return false;<tr><td><a name="l360" href="#l360">360</a><td> }<tr><td><a name="l361" href="#l361">361</a><td>};<tr><td><a name="l362" href="#l362">362</a><td><tr><td><a name="l363" href="#l363">363</a><td><tr><td><a name="l364" href="#l364">364</a><td>/**<tr><td><a name="l365" href="#l365">365</a><td> * Normalizes key codes from OS/Browser-specific value to the general one.<tr><td><a name="l366" href="#l366">366</a><td> * @param {number} keyCode The native key code.<tr><td><a name="l367" href="#l367">367</a><td> * @return {number} The normalized key code.<tr><td><a name="l368" href="#l368">368</a><td> */<tr><td><a name="l369" href="#l369">369</a><td>goog.events.KeyCodes.normalizeKeyCode = function(keyCode) {<tr><td><a name="l370" href="#l370">370</a><td> if (goog.userAgent.GECKO) {<tr><td><a name="l371" href="#l371">371</a><td> return goog.events.KeyCodes.normalizeGeckoKeyCode(keyCode);<tr><td><a name="l372" href="#l372">372</a><td> } else if (goog.userAgent.MAC &amp;&amp; goog.userAgent.WEBKIT) {<tr><td><a name="l373" href="#l373">373</a><td> return goog.events.KeyCodes.normalizeMacWebKitKeyCode(keyCode);<tr><td><a name="l374" href="#l374">374</a><td> } else {<tr><td><a name="l375" href="#l375">375</a><td> return keyCode;<tr><td><a name="l376" href="#l376">376</a><td> }<tr><td><a name="l377" href="#l377">377</a><td>};<tr><td><a name="l378" href="#l378">378</a><td><tr><td><a name="l379" href="#l379">379</a><td><tr><td><a name="l380" href="#l380">380</a><td>/**<tr><td><a name="l381" href="#l381">381</a><td> * Normalizes key codes from their Gecko-specific value to the general one.<tr><td><a name="l382" href="#l382">382</a><td> * @param {number} keyCode The native key code.<tr><td><a name="l383" href="#l383">383</a><td> * @return {number} The normalized key code.<tr><td><a name="l384" href="#l384">384</a><td> */<tr><td><a name="l385" href="#l385">385</a><td>goog.events.KeyCodes.normalizeGeckoKeyCode = function(keyCode) {<tr><td><a name="l386" href="#l386">386</a><td> switch (keyCode) {<tr><td><a name="l387" href="#l387">387</a><td> case goog.events.KeyCodes.FF_EQUALS:<tr><td><a name="l388" href="#l388">388</a><td> return goog.events.KeyCodes.EQUALS;<tr><td><a name="l389" href="#l389">389</a><td> case goog.events.KeyCodes.FF_SEMICOLON:<tr><td><a name="l390" href="#l390">390</a><td> return goog.events.KeyCodes.SEMICOLON;<tr><td><a name="l391" href="#l391">391</a><td> case goog.events.KeyCodes.FF_DASH:<tr><td><a name="l392" href="#l392">392</a><td> return goog.events.KeyCodes.DASH;<tr><td><a name="l393" href="#l393">393</a><td> case goog.events.KeyCodes.MAC_FF_META:<tr><td><a name="l394" href="#l394">394</a><td> return goog.events.KeyCodes.META;<tr><td><a name="l395" href="#l395">395</a><td> case goog.events.KeyCodes.WIN_KEY_FF_LINUX:<tr><td><a name="l396" href="#l396">396</a><td> return goog.events.KeyCodes.WIN_KEY;<tr><td><a name="l397" href="#l397">397</a><td> default:<tr><td><a name="l398" href="#l398">398</a><td> return keyCode;<tr><td><a name="l399" href="#l399">399</a><td> }<tr><td><a name="l400" href="#l400">400</a><td>};<tr><td><a name="l401" href="#l401">401</a><td><tr><td><a name="l402" href="#l402">402</a><td><tr><td><a name="l403" href="#l403">403</a><td>/**<tr><td><a name="l404" href="#l404">404</a><td> * Normalizes key codes from their Mac WebKit-specific value to the general one.<tr><td><a name="l405" href="#l405">405</a><td> * @param {number} keyCode The native key code.<tr><td><a name="l406" href="#l406">406</a><td> * @return {number} The normalized key code.<tr><td><a name="l407" href="#l407">407</a><td> */<tr><td><a name="l408" href="#l408">408</a><td>goog.events.KeyCodes.normalizeMacWebKitKeyCode = function(keyCode) {<tr><td><a name="l409" href="#l409">409</a><td> switch (keyCode) {<tr><td><a name="l410" href="#l410">410</a><td> case goog.events.KeyCodes.MAC_WK_CMD_RIGHT: // 93<tr><td><a name="l411" href="#l411">411</a><td> return goog.events.KeyCodes.META; // 91<tr><td><a name="l412" href="#l412">412</a><td> default:<tr><td><a name="l413" href="#l413">413</a><td> return keyCode;<tr><td><a name="l414" href="#l414">414</a><td> }<tr><td><a name="l415" href="#l415">415</a><td>};</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="../../../../license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../../types.js"></script><script src="../../../../dossier.js"></script>
package/docs/source/lib/goog/events/listenable.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>listenable.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/events/listenable.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2012 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview An interface for a listenable JavaScript object.<tr><td><a name="l17" href="#l17">17</a><td> */<tr><td><a name="l18" href="#l18">18</a><td><tr><td><a name="l19" href="#l19">19</a><td>goog.provide(&#39;goog.events.Listenable&#39;);<tr><td><a name="l20" href="#l20">20</a><td>goog.provide(&#39;goog.events.ListenableKey&#39;);<tr><td><a name="l21" href="#l21">21</a><td><tr><td><a name="l22" href="#l22">22</a><td>/** @suppress {extraRequire} */<tr><td><a name="l23" href="#l23">23</a><td>goog.require(&#39;goog.events.EventId&#39;);<tr><td><a name="l24" href="#l24">24</a><td><tr><td><a name="l25" href="#l25">25</a><td><tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td>/**<tr><td><a name="l28" href="#l28">28</a><td> * A listenable interface. A listenable is an object with the ability<tr><td><a name="l29" href="#l29">29</a><td> * to dispatch/broadcast events to &quot;event listeners&quot; registered via<tr><td><a name="l30" href="#l30">30</a><td> * listen/listenOnce.<tr><td><a name="l31" href="#l31">31</a><td> *<tr><td><a name="l32" href="#l32">32</a><td> * The interface allows for an event propagation mechanism similar<tr><td><a name="l33" href="#l33">33</a><td> * to one offered by native browser event targets, such as<tr><td><a name="l34" href="#l34">34</a><td> * capture/bubble mechanism, stopping propagation, and preventing<tr><td><a name="l35" href="#l35">35</a><td> * default actions. Capture/bubble mechanism depends on the ancestor<tr><td><a name="l36" href="#l36">36</a><td> * tree constructed via {@code #getParentEventTarget}; this tree<tr><td><a name="l37" href="#l37">37</a><td> * must be directed acyclic graph. The meaning of default action(s)<tr><td><a name="l38" href="#l38">38</a><td> * in preventDefault is specific to a particular use case.<tr><td><a name="l39" href="#l39">39</a><td> *<tr><td><a name="l40" href="#l40">40</a><td> * Implementations that do not support capture/bubble or can not have<tr><td><a name="l41" href="#l41">41</a><td> * a parent listenable can simply not implement any ability to set the<tr><td><a name="l42" href="#l42">42</a><td> * parent listenable (and have {@code #getParentEventTarget} return<tr><td><a name="l43" href="#l43">43</a><td> * null).<tr><td><a name="l44" href="#l44">44</a><td> *<tr><td><a name="l45" href="#l45">45</a><td> * Implementation of this class can be used with or independently from<tr><td><a name="l46" href="#l46">46</a><td> * goog.events.<tr><td><a name="l47" href="#l47">47</a><td> *<tr><td><a name="l48" href="#l48">48</a><td> * Implementation must call {@code #addImplementation(implClass)}.<tr><td><a name="l49" href="#l49">49</a><td> *<tr><td><a name="l50" href="#l50">50</a><td> * @interface<tr><td><a name="l51" href="#l51">51</a><td> * @see goog.events<tr><td><a name="l52" href="#l52">52</a><td> * @see http://www.w3.org/TR/DOM-Level-2-Events/events.html<tr><td><a name="l53" href="#l53">53</a><td> */<tr><td><a name="l54" href="#l54">54</a><td>goog.events.Listenable = function() {};<tr><td><a name="l55" href="#l55">55</a><td><tr><td><a name="l56" href="#l56">56</a><td><tr><td><a name="l57" href="#l57">57</a><td>/**<tr><td><a name="l58" href="#l58">58</a><td> * An expando property to indicate that an object implements<tr><td><a name="l59" href="#l59">59</a><td> * goog.events.Listenable.<tr><td><a name="l60" href="#l60">60</a><td> *<tr><td><a name="l61" href="#l61">61</a><td> * See addImplementation/isImplementedBy.<tr><td><a name="l62" href="#l62">62</a><td> *<tr><td><a name="l63" href="#l63">63</a><td> * @type {string}<tr><td><a name="l64" href="#l64">64</a><td> * @const<tr><td><a name="l65" href="#l65">65</a><td> */<tr><td><a name="l66" href="#l66">66</a><td>goog.events.Listenable.IMPLEMENTED_BY_PROP =<tr><td><a name="l67" href="#l67">67</a><td> &#39;closure_listenable_&#39; + ((Math.random() * 1e6) | 0);<tr><td><a name="l68" href="#l68">68</a><td><tr><td><a name="l69" href="#l69">69</a><td><tr><td><a name="l70" href="#l70">70</a><td>/**<tr><td><a name="l71" href="#l71">71</a><td> * Marks a given class (constructor) as an implementation of<tr><td><a name="l72" href="#l72">72</a><td> * Listenable, do that we can query that fact at runtime. The class<tr><td><a name="l73" href="#l73">73</a><td> * must have already implemented the interface.<tr><td><a name="l74" href="#l74">74</a><td> * @param {!Function} cls The class constructor. The corresponding<tr><td><a name="l75" href="#l75">75</a><td> * class must have already implemented the interface.<tr><td><a name="l76" href="#l76">76</a><td> */<tr><td><a name="l77" href="#l77">77</a><td>goog.events.Listenable.addImplementation = function(cls) {<tr><td><a name="l78" href="#l78">78</a><td> cls.prototype[goog.events.Listenable.IMPLEMENTED_BY_PROP] = true;<tr><td><a name="l79" href="#l79">79</a><td>};<tr><td><a name="l80" href="#l80">80</a><td><tr><td><a name="l81" href="#l81">81</a><td><tr><td><a name="l82" href="#l82">82</a><td>/**<tr><td><a name="l83" href="#l83">83</a><td> * @param {Object} obj The object to check.<tr><td><a name="l84" href="#l84">84</a><td> * @return {boolean} Whether a given instance implements Listenable. The<tr><td><a name="l85" href="#l85">85</a><td> * class/superclass of the instance must call addImplementation.<tr><td><a name="l86" href="#l86">86</a><td> */<tr><td><a name="l87" href="#l87">87</a><td>goog.events.Listenable.isImplementedBy = function(obj) {<tr><td><a name="l88" href="#l88">88</a><td> return !!(obj &amp;&amp; obj[goog.events.Listenable.IMPLEMENTED_BY_PROP]);<tr><td><a name="l89" href="#l89">89</a><td>};<tr><td><a name="l90" href="#l90">90</a><td><tr><td><a name="l91" href="#l91">91</a><td><tr><td><a name="l92" href="#l92">92</a><td>/**<tr><td><a name="l93" href="#l93">93</a><td> * Adds an event listener. A listener can only be added once to an<tr><td><a name="l94" href="#l94">94</a><td> * object and if it is added again the key for the listener is<tr><td><a name="l95" href="#l95">95</a><td> * returned. Note that if the existing listener is a one-off listener<tr><td><a name="l96" href="#l96">96</a><td> * (registered via listenOnce), it will no longer be a one-off<tr><td><a name="l97" href="#l97">97</a><td> * listener after a call to listen().<tr><td><a name="l98" href="#l98">98</a><td> *<tr><td><a name="l99" href="#l99">99</a><td> * @param {string|!goog.events.EventId.&lt;EVENTOBJ&gt;} type The event type id.<tr><td><a name="l100" href="#l100">100</a><td> * @param {function(this:SCOPE, EVENTOBJ):(boolean|undefined)} listener Callback<tr><td><a name="l101" href="#l101">101</a><td> * method.<tr><td><a name="l102" href="#l102">102</a><td> * @param {boolean=} opt_useCapture Whether to fire in capture phase<tr><td><a name="l103" href="#l103">103</a><td> * (defaults to false).<tr><td><a name="l104" href="#l104">104</a><td> * @param {SCOPE=} opt_listenerScope Object in whose scope to call the<tr><td><a name="l105" href="#l105">105</a><td> * listener.<tr><td><a name="l106" href="#l106">106</a><td> * @return {goog.events.ListenableKey} Unique key for the listener.<tr><td><a name="l107" href="#l107">107</a><td> * @template SCOPE,EVENTOBJ<tr><td><a name="l108" href="#l108">108</a><td> */<tr><td><a name="l109" href="#l109">109</a><td>goog.events.Listenable.prototype.listen;<tr><td><a name="l110" href="#l110">110</a><td><tr><td><a name="l111" href="#l111">111</a><td><tr><td><a name="l112" href="#l112">112</a><td>/**<tr><td><a name="l113" href="#l113">113</a><td> * Adds an event listener that is removed automatically after the<tr><td><a name="l114" href="#l114">114</a><td> * listener fired once.<tr><td><a name="l115" href="#l115">115</a><td> *<tr><td><a name="l116" href="#l116">116</a><td> * If an existing listener already exists, listenOnce will do<tr><td><a name="l117" href="#l117">117</a><td> * nothing. In particular, if the listener was previously registered<tr><td><a name="l118" href="#l118">118</a><td> * via listen(), listenOnce() will not turn the listener into a<tr><td><a name="l119" href="#l119">119</a><td> * one-off listener. Similarly, if there is already an existing<tr><td><a name="l120" href="#l120">120</a><td> * one-off listener, listenOnce does not modify the listeners (it is<tr><td><a name="l121" href="#l121">121</a><td> * still a once listener).<tr><td><a name="l122" href="#l122">122</a><td> *<tr><td><a name="l123" href="#l123">123</a><td> * @param {string|!goog.events.EventId.&lt;EVENTOBJ&gt;} type The event type id.<tr><td><a name="l124" href="#l124">124</a><td> * @param {function(this:SCOPE, EVENTOBJ):(boolean|undefined)} listener Callback<tr><td><a name="l125" href="#l125">125</a><td> * method.<tr><td><a name="l126" href="#l126">126</a><td> * @param {boolean=} opt_useCapture Whether to fire in capture phase<tr><td><a name="l127" href="#l127">127</a><td> * (defaults to false).<tr><td><a name="l128" href="#l128">128</a><td> * @param {SCOPE=} opt_listenerScope Object in whose scope to call the<tr><td><a name="l129" href="#l129">129</a><td> * listener.<tr><td><a name="l130" href="#l130">130</a><td> * @return {goog.events.ListenableKey} Unique key for the listener.<tr><td><a name="l131" href="#l131">131</a><td> * @template SCOPE,EVENTOBJ<tr><td><a name="l132" href="#l132">132</a><td> */<tr><td><a name="l133" href="#l133">133</a><td>goog.events.Listenable.prototype.listenOnce;<tr><td><a name="l134" href="#l134">134</a><td><tr><td><a name="l135" href="#l135">135</a><td><tr><td><a name="l136" href="#l136">136</a><td>/**<tr><td><a name="l137" href="#l137">137</a><td> * Removes an event listener which was added with listen() or listenOnce().<tr><td><a name="l138" href="#l138">138</a><td> *<tr><td><a name="l139" href="#l139">139</a><td> * @param {string|!goog.events.EventId.&lt;EVENTOBJ&gt;} type The event type id.<tr><td><a name="l140" href="#l140">140</a><td> * @param {function(this:SCOPE, EVENTOBJ):(boolean|undefined)} listener Callback<tr><td><a name="l141" href="#l141">141</a><td> * method.<tr><td><a name="l142" href="#l142">142</a><td> * @param {boolean=} opt_useCapture Whether to fire in capture phase<tr><td><a name="l143" href="#l143">143</a><td> * (defaults to false).<tr><td><a name="l144" href="#l144">144</a><td> * @param {SCOPE=} opt_listenerScope Object in whose scope to call<tr><td><a name="l145" href="#l145">145</a><td> * the listener.<tr><td><a name="l146" href="#l146">146</a><td> * @return {boolean} Whether any listener was removed.<tr><td><a name="l147" href="#l147">147</a><td> * @template SCOPE,EVENTOBJ<tr><td><a name="l148" href="#l148">148</a><td> */<tr><td><a name="l149" href="#l149">149</a><td>goog.events.Listenable.prototype.unlisten;<tr><td><a name="l150" href="#l150">150</a><td><tr><td><a name="l151" href="#l151">151</a><td><tr><td><a name="l152" href="#l152">152</a><td>/**<tr><td><a name="l153" href="#l153">153</a><td> * Removes an event listener which was added with listen() by the key<tr><td><a name="l154" href="#l154">154</a><td> * returned by listen().<tr><td><a name="l155" href="#l155">155</a><td> *<tr><td><a name="l156" href="#l156">156</a><td> * @param {goog.events.ListenableKey} key The key returned by<tr><td><a name="l157" href="#l157">157</a><td> * listen() or listenOnce().<tr><td><a name="l158" href="#l158">158</a><td> * @return {boolean} Whether any listener was removed.<tr><td><a name="l159" href="#l159">159</a><td> */<tr><td><a name="l160" href="#l160">160</a><td>goog.events.Listenable.prototype.unlistenByKey;<tr><td><a name="l161" href="#l161">161</a><td><tr><td><a name="l162" href="#l162">162</a><td><tr><td><a name="l163" href="#l163">163</a><td>/**<tr><td><a name="l164" href="#l164">164</a><td> * Dispatches an event (or event like object) and calls all listeners<tr><td><a name="l165" href="#l165">165</a><td> * listening for events of this type. The type of the event is decided by the<tr><td><a name="l166" href="#l166">166</a><td> * type property on the event object.<tr><td><a name="l167" href="#l167">167</a><td> *<tr><td><a name="l168" href="#l168">168</a><td> * If any of the listeners returns false OR calls preventDefault then this<tr><td><a name="l169" href="#l169">169</a><td> * function will return false. If one of the capture listeners calls<tr><td><a name="l170" href="#l170">170</a><td> * stopPropagation, then the bubble listeners won&#39;t fire.<tr><td><a name="l171" href="#l171">171</a><td> *<tr><td><a name="l172" href="#l172">172</a><td> * @param {goog.events.EventLike} e Event object.<tr><td><a name="l173" href="#l173">173</a><td> * @return {boolean} If anyone called preventDefault on the event object (or<tr><td><a name="l174" href="#l174">174</a><td> * if any of the listeners returns false) this will also return false.<tr><td><a name="l175" href="#l175">175</a><td> */<tr><td><a name="l176" href="#l176">176</a><td>goog.events.Listenable.prototype.dispatchEvent;<tr><td><a name="l177" href="#l177">177</a><td><tr><td><a name="l178" href="#l178">178</a><td><tr><td><a name="l179" href="#l179">179</a><td>/**<tr><td><a name="l180" href="#l180">180</a><td> * Removes all listeners from this listenable. If type is specified,<tr><td><a name="l181" href="#l181">181</a><td> * it will only remove listeners of the particular type. otherwise all<tr><td><a name="l182" href="#l182">182</a><td> * registered listeners will be removed.<tr><td><a name="l183" href="#l183">183</a><td> *<tr><td><a name="l184" href="#l184">184</a><td> * @param {string=} opt_type Type of event to remove, default is to<tr><td><a name="l185" href="#l185">185</a><td> * remove all types.<tr><td><a name="l186" href="#l186">186</a><td> * @return {number} Number of listeners removed.<tr><td><a name="l187" href="#l187">187</a><td> */<tr><td><a name="l188" href="#l188">188</a><td>goog.events.Listenable.prototype.removeAllListeners;<tr><td><a name="l189" href="#l189">189</a><td><tr><td><a name="l190" href="#l190">190</a><td><tr><td><a name="l191" href="#l191">191</a><td>/**<tr><td><a name="l192" href="#l192">192</a><td> * Returns the parent of this event target to use for capture/bubble<tr><td><a name="l193" href="#l193">193</a><td> * mechanism.<tr><td><a name="l194" href="#l194">194</a><td> *<tr><td><a name="l195" href="#l195">195</a><td> * NOTE(user): The name reflects the original implementation of<tr><td><a name="l196" href="#l196">196</a><td> * custom event target ({@code goog.events.EventTarget}). We decided<tr><td><a name="l197" href="#l197">197</a><td> * that changing the name is not worth it.<tr><td><a name="l198" href="#l198">198</a><td> *<tr><td><a name="l199" href="#l199">199</a><td> * @return {goog.events.Listenable} The parent EventTarget or null if<tr><td><a name="l200" href="#l200">200</a><td> * there is no parent.<tr><td><a name="l201" href="#l201">201</a><td> */<tr><td><a name="l202" href="#l202">202</a><td>goog.events.Listenable.prototype.getParentEventTarget;<tr><td><a name="l203" href="#l203">203</a><td><tr><td><a name="l204" href="#l204">204</a><td><tr><td><a name="l205" href="#l205">205</a><td>/**<tr><td><a name="l206" href="#l206">206</a><td> * Fires all registered listeners in this listenable for the given<tr><td><a name="l207" href="#l207">207</a><td> * type and capture mode, passing them the given eventObject. This<tr><td><a name="l208" href="#l208">208</a><td> * does not perform actual capture/bubble. Only implementors of the<tr><td><a name="l209" href="#l209">209</a><td> * interface should be using this.<tr><td><a name="l210" href="#l210">210</a><td> *<tr><td><a name="l211" href="#l211">211</a><td> * @param {string|!goog.events.EventId.&lt;EVENTOBJ&gt;} type The type of the<tr><td><a name="l212" href="#l212">212</a><td> * listeners to fire.<tr><td><a name="l213" href="#l213">213</a><td> * @param {boolean} capture The capture mode of the listeners to fire.<tr><td><a name="l214" href="#l214">214</a><td> * @param {EVENTOBJ} eventObject The event object to fire.<tr><td><a name="l215" href="#l215">215</a><td> * @return {boolean} Whether all listeners succeeded without<tr><td><a name="l216" href="#l216">216</a><td> * attempting to prevent default behavior. If any listener returns<tr><td><a name="l217" href="#l217">217</a><td> * false or called goog.events.Event#preventDefault, this returns<tr><td><a name="l218" href="#l218">218</a><td> * false.<tr><td><a name="l219" href="#l219">219</a><td> * @template EVENTOBJ<tr><td><a name="l220" href="#l220">220</a><td> */<tr><td><a name="l221" href="#l221">221</a><td>goog.events.Listenable.prototype.fireListeners;<tr><td><a name="l222" href="#l222">222</a><td><tr><td><a name="l223" href="#l223">223</a><td><tr><td><a name="l224" href="#l224">224</a><td>/**<tr><td><a name="l225" href="#l225">225</a><td> * Gets all listeners in this listenable for the given type and<tr><td><a name="l226" href="#l226">226</a><td> * capture mode.<tr><td><a name="l227" href="#l227">227</a><td> *<tr><td><a name="l228" href="#l228">228</a><td> * @param {string|!goog.events.EventId} type The type of the listeners to fire.<tr><td><a name="l229" href="#l229">229</a><td> * @param {boolean} capture The capture mode of the listeners to fire.<tr><td><a name="l230" href="#l230">230</a><td> * @return {!Array.&lt;goog.events.ListenableKey&gt;} An array of registered<tr><td><a name="l231" href="#l231">231</a><td> * listeners.<tr><td><a name="l232" href="#l232">232</a><td> * @template EVENTOBJ<tr><td><a name="l233" href="#l233">233</a><td> */<tr><td><a name="l234" href="#l234">234</a><td>goog.events.Listenable.prototype.getListeners;<tr><td><a name="l235" href="#l235">235</a><td><tr><td><a name="l236" href="#l236">236</a><td><tr><td><a name="l237" href="#l237">237</a><td>/**<tr><td><a name="l238" href="#l238">238</a><td> * Gets the goog.events.ListenableKey for the event or null if no such<tr><td><a name="l239" href="#l239">239</a><td> * listener is in use.<tr><td><a name="l240" href="#l240">240</a><td> *<tr><td><a name="l241" href="#l241">241</a><td> * @param {string|!goog.events.EventId.&lt;EVENTOBJ&gt;} type The name of the event<tr><td><a name="l242" href="#l242">242</a><td> * without the &#39;on&#39; prefix.<tr><td><a name="l243" href="#l243">243</a><td> * @param {function(this:SCOPE, EVENTOBJ):(boolean|undefined)} listener The<tr><td><a name="l244" href="#l244">244</a><td> * listener function to get.<tr><td><a name="l245" href="#l245">245</a><td> * @param {boolean} capture Whether the listener is a capturing listener.<tr><td><a name="l246" href="#l246">246</a><td> * @param {SCOPE=} opt_listenerScope Object in whose scope to call the<tr><td><a name="l247" href="#l247">247</a><td> * listener.<tr><td><a name="l248" href="#l248">248</a><td> * @return {goog.events.ListenableKey} the found listener or null if not found.<tr><td><a name="l249" href="#l249">249</a><td> * @template SCOPE,EVENTOBJ<tr><td><a name="l250" href="#l250">250</a><td> */<tr><td><a name="l251" href="#l251">251</a><td>goog.events.Listenable.prototype.getListener;<tr><td><a name="l252" href="#l252">252</a><td><tr><td><a name="l253" href="#l253">253</a><td><tr><td><a name="l254" href="#l254">254</a><td>/**<tr><td><a name="l255" href="#l255">255</a><td> * Whether there is any active listeners matching the specified<tr><td><a name="l256" href="#l256">256</a><td> * signature. If either the type or capture parameters are<tr><td><a name="l257" href="#l257">257</a><td> * unspecified, the function will match on the remaining criteria.<tr><td><a name="l258" href="#l258">258</a><td> *<tr><td><a name="l259" href="#l259">259</a><td> * @param {string|!goog.events.EventId.&lt;EVENTOBJ&gt;=} opt_type Event type.<tr><td><a name="l260" href="#l260">260</a><td> * @param {boolean=} opt_capture Whether to check for capture or bubble<tr><td><a name="l261" href="#l261">261</a><td> * listeners.<tr><td><a name="l262" href="#l262">262</a><td> * @return {boolean} Whether there is any active listeners matching<tr><td><a name="l263" href="#l263">263</a><td> * the requested type and/or capture phase.<tr><td><a name="l264" href="#l264">264</a><td> * @template EVENTOBJ<tr><td><a name="l265" href="#l265">265</a><td> */<tr><td><a name="l266" href="#l266">266</a><td>goog.events.Listenable.prototype.hasListener;<tr><td><a name="l267" href="#l267">267</a><td><tr><td><a name="l268" href="#l268">268</a><td><tr><td><a name="l269" href="#l269">269</a><td><tr><td><a name="l270" href="#l270">270</a><td>/**<tr><td><a name="l271" href="#l271">271</a><td> * An interface that describes a single registered listener.<tr><td><a name="l272" href="#l272">272</a><td> * @interface<tr><td><a name="l273" href="#l273">273</a><td> */<tr><td><a name="l274" href="#l274">274</a><td>goog.events.ListenableKey = function() {};<tr><td><a name="l275" href="#l275">275</a><td><tr><td><a name="l276" href="#l276">276</a><td><tr><td><a name="l277" href="#l277">277</a><td>/**<tr><td><a name="l278" href="#l278">278</a><td> * Counter used to create a unique key<tr><td><a name="l279" href="#l279">279</a><td> * @type {number}<tr><td><a name="l280" href="#l280">280</a><td> * @private<tr><td><a name="l281" href="#l281">281</a><td> */<tr><td><a name="l282" href="#l282">282</a><td>goog.events.ListenableKey.counter_ = 0;<tr><td><a name="l283" href="#l283">283</a><td><tr><td><a name="l284" href="#l284">284</a><td><tr><td><a name="l285" href="#l285">285</a><td>/**<tr><td><a name="l286" href="#l286">286</a><td> * Reserves a key to be used for ListenableKey#key field.<tr><td><a name="l287" href="#l287">287</a><td> * @return {number} A number to be used to fill ListenableKey#key<tr><td><a name="l288" href="#l288">288</a><td> * field.<tr><td><a name="l289" href="#l289">289</a><td> */<tr><td><a name="l290" href="#l290">290</a><td>goog.events.ListenableKey.reserveKey = function() {<tr><td><a name="l291" href="#l291">291</a><td> return ++goog.events.ListenableKey.counter_;<tr><td><a name="l292" href="#l292">292</a><td>};<tr><td><a name="l293" href="#l293">293</a><td><tr><td><a name="l294" href="#l294">294</a><td><tr><td><a name="l295" href="#l295">295</a><td>/**<tr><td><a name="l296" href="#l296">296</a><td> * The source event target.<tr><td><a name="l297" href="#l297">297</a><td> * @type {!(Object|goog.events.Listenable|goog.events.EventTarget)}<tr><td><a name="l298" href="#l298">298</a><td> */<tr><td><a name="l299" href="#l299">299</a><td>goog.events.ListenableKey.prototype.src;<tr><td><a name="l300" href="#l300">300</a><td><tr><td><a name="l301" href="#l301">301</a><td><tr><td><a name="l302" href="#l302">302</a><td>/**<tr><td><a name="l303" href="#l303">303</a><td> * The event type the listener is listening to.<tr><td><a name="l304" href="#l304">304</a><td> * @type {string}<tr><td><a name="l305" href="#l305">305</a><td> */<tr><td><a name="l306" href="#l306">306</a><td>goog.events.ListenableKey.prototype.type;<tr><td><a name="l307" href="#l307">307</a><td><tr><td><a name="l308" href="#l308">308</a><td><tr><td><a name="l309" href="#l309">309</a><td>/**<tr><td><a name="l310" href="#l310">310</a><td> * The listener function.<tr><td><a name="l311" href="#l311">311</a><td> * @type {function(?):?|{handleEvent:function(?):?}|null}<tr><td><a name="l312" href="#l312">312</a><td> */<tr><td><a name="l313" href="#l313">313</a><td>goog.events.ListenableKey.prototype.listener;<tr><td><a name="l314" href="#l314">314</a><td><tr><td><a name="l315" href="#l315">315</a><td><tr><td><a name="l316" href="#l316">316</a><td>/**<tr><td><a name="l317" href="#l317">317</a><td> * Whether the listener works on capture phase.<tr><td><a name="l318" href="#l318">318</a><td> * @type {boolean}<tr><td><a name="l319" href="#l319">319</a><td> */<tr><td><a name="l320" href="#l320">320</a><td>goog.events.ListenableKey.prototype.capture;<tr><td><a name="l321" href="#l321">321</a><td><tr><td><a name="l322" href="#l322">322</a><td><tr><td><a name="l323" href="#l323">323</a><td>/**<tr><td><a name="l324" href="#l324">324</a><td> * The &#39;this&#39; object for the listener function&#39;s scope.<tr><td><a name="l325" href="#l325">325</a><td> * @type {Object}<tr><td><a name="l326" href="#l326">326</a><td> */<tr><td><a name="l327" href="#l327">327</a><td>goog.events.ListenableKey.prototype.handler;<tr><td><a name="l328" href="#l328">328</a><td><tr><td><a name="l329" href="#l329">329</a><td><tr><td><a name="l330" href="#l330">330</a><td>/**<tr><td><a name="l331" href="#l331">331</a><td> * A globally unique number to identify the key.<tr><td><a name="l332" href="#l332">332</a><td> * @type {number}<tr><td><a name="l333" href="#l333">333</a><td> */<tr><td><a name="l334" href="#l334">334</a><td>goog.events.ListenableKey.prototype.key;</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../../types.js"></script><script src="../../../../dossier.js"></script>
1
+ <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>listenable.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/events/listenable.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2012 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview An interface for a listenable JavaScript object.<tr><td><a name="l17" href="#l17">17</a><td> */<tr><td><a name="l18" href="#l18">18</a><td><tr><td><a name="l19" href="#l19">19</a><td>goog.provide(&#39;goog.events.Listenable&#39;);<tr><td><a name="l20" href="#l20">20</a><td>goog.provide(&#39;goog.events.ListenableKey&#39;);<tr><td><a name="l21" href="#l21">21</a><td><tr><td><a name="l22" href="#l22">22</a><td>/** @suppress {extraRequire} */<tr><td><a name="l23" href="#l23">23</a><td>goog.require(&#39;goog.events.EventId&#39;);<tr><td><a name="l24" href="#l24">24</a><td><tr><td><a name="l25" href="#l25">25</a><td><tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td>/**<tr><td><a name="l28" href="#l28">28</a><td> * A listenable interface. A listenable is an object with the ability<tr><td><a name="l29" href="#l29">29</a><td> * to dispatch/broadcast events to &quot;event listeners&quot; registered via<tr><td><a name="l30" href="#l30">30</a><td> * listen/listenOnce.<tr><td><a name="l31" href="#l31">31</a><td> *<tr><td><a name="l32" href="#l32">32</a><td> * The interface allows for an event propagation mechanism similar<tr><td><a name="l33" href="#l33">33</a><td> * to one offered by native browser event targets, such as<tr><td><a name="l34" href="#l34">34</a><td> * capture/bubble mechanism, stopping propagation, and preventing<tr><td><a name="l35" href="#l35">35</a><td> * default actions. Capture/bubble mechanism depends on the ancestor<tr><td><a name="l36" href="#l36">36</a><td> * tree constructed via {@code #getParentEventTarget}; this tree<tr><td><a name="l37" href="#l37">37</a><td> * must be directed acyclic graph. The meaning of default action(s)<tr><td><a name="l38" href="#l38">38</a><td> * in preventDefault is specific to a particular use case.<tr><td><a name="l39" href="#l39">39</a><td> *<tr><td><a name="l40" href="#l40">40</a><td> * Implementations that do not support capture/bubble or can not have<tr><td><a name="l41" href="#l41">41</a><td> * a parent listenable can simply not implement any ability to set the<tr><td><a name="l42" href="#l42">42</a><td> * parent listenable (and have {@code #getParentEventTarget} return<tr><td><a name="l43" href="#l43">43</a><td> * null).<tr><td><a name="l44" href="#l44">44</a><td> *<tr><td><a name="l45" href="#l45">45</a><td> * Implementation of this class can be used with or independently from<tr><td><a name="l46" href="#l46">46</a><td> * goog.events.<tr><td><a name="l47" href="#l47">47</a><td> *<tr><td><a name="l48" href="#l48">48</a><td> * Implementation must call {@code #addImplementation(implClass)}.<tr><td><a name="l49" href="#l49">49</a><td> *<tr><td><a name="l50" href="#l50">50</a><td> * @interface<tr><td><a name="l51" href="#l51">51</a><td> * @see goog.events<tr><td><a name="l52" href="#l52">52</a><td> * @see http://www.w3.org/TR/DOM-Level-2-Events/events.html<tr><td><a name="l53" href="#l53">53</a><td> */<tr><td><a name="l54" href="#l54">54</a><td>goog.events.Listenable = function() {};<tr><td><a name="l55" href="#l55">55</a><td><tr><td><a name="l56" href="#l56">56</a><td><tr><td><a name="l57" href="#l57">57</a><td>/**<tr><td><a name="l58" href="#l58">58</a><td> * An expando property to indicate that an object implements<tr><td><a name="l59" href="#l59">59</a><td> * goog.events.Listenable.<tr><td><a name="l60" href="#l60">60</a><td> *<tr><td><a name="l61" href="#l61">61</a><td> * See addImplementation/isImplementedBy.<tr><td><a name="l62" href="#l62">62</a><td> *<tr><td><a name="l63" href="#l63">63</a><td> * @type {string}<tr><td><a name="l64" href="#l64">64</a><td> * @const<tr><td><a name="l65" href="#l65">65</a><td> */<tr><td><a name="l66" href="#l66">66</a><td>goog.events.Listenable.IMPLEMENTED_BY_PROP =<tr><td><a name="l67" href="#l67">67</a><td> &#39;closure_listenable_&#39; + ((Math.random() * 1e6) | 0);<tr><td><a name="l68" href="#l68">68</a><td><tr><td><a name="l69" href="#l69">69</a><td><tr><td><a name="l70" href="#l70">70</a><td>/**<tr><td><a name="l71" href="#l71">71</a><td> * Marks a given class (constructor) as an implementation of<tr><td><a name="l72" href="#l72">72</a><td> * Listenable, do that we can query that fact at runtime. The class<tr><td><a name="l73" href="#l73">73</a><td> * must have already implemented the interface.<tr><td><a name="l74" href="#l74">74</a><td> * @param {!Function} cls The class constructor. The corresponding<tr><td><a name="l75" href="#l75">75</a><td> * class must have already implemented the interface.<tr><td><a name="l76" href="#l76">76</a><td> */<tr><td><a name="l77" href="#l77">77</a><td>goog.events.Listenable.addImplementation = function(cls) {<tr><td><a name="l78" href="#l78">78</a><td> cls.prototype[goog.events.Listenable.IMPLEMENTED_BY_PROP] = true;<tr><td><a name="l79" href="#l79">79</a><td>};<tr><td><a name="l80" href="#l80">80</a><td><tr><td><a name="l81" href="#l81">81</a><td><tr><td><a name="l82" href="#l82">82</a><td>/**<tr><td><a name="l83" href="#l83">83</a><td> * @param {Object} obj The object to check.<tr><td><a name="l84" href="#l84">84</a><td> * @return {boolean} Whether a given instance implements Listenable. The<tr><td><a name="l85" href="#l85">85</a><td> * class/superclass of the instance must call addImplementation.<tr><td><a name="l86" href="#l86">86</a><td> */<tr><td><a name="l87" href="#l87">87</a><td>goog.events.Listenable.isImplementedBy = function(obj) {<tr><td><a name="l88" href="#l88">88</a><td> return !!(obj &amp;&amp; obj[goog.events.Listenable.IMPLEMENTED_BY_PROP]);<tr><td><a name="l89" href="#l89">89</a><td>};<tr><td><a name="l90" href="#l90">90</a><td><tr><td><a name="l91" href="#l91">91</a><td><tr><td><a name="l92" href="#l92">92</a><td>/**<tr><td><a name="l93" href="#l93">93</a><td> * Adds an event listener. A listener can only be added once to an<tr><td><a name="l94" href="#l94">94</a><td> * object and if it is added again the key for the listener is<tr><td><a name="l95" href="#l95">95</a><td> * returned. Note that if the existing listener is a one-off listener<tr><td><a name="l96" href="#l96">96</a><td> * (registered via listenOnce), it will no longer be a one-off<tr><td><a name="l97" href="#l97">97</a><td> * listener after a call to listen().<tr><td><a name="l98" href="#l98">98</a><td> *<tr><td><a name="l99" href="#l99">99</a><td> * @param {string|!goog.events.EventId.&lt;EVENTOBJ&gt;} type The event type id.<tr><td><a name="l100" href="#l100">100</a><td> * @param {function(this:SCOPE, EVENTOBJ):(boolean|undefined)} listener Callback<tr><td><a name="l101" href="#l101">101</a><td> * method.<tr><td><a name="l102" href="#l102">102</a><td> * @param {boolean=} opt_useCapture Whether to fire in capture phase<tr><td><a name="l103" href="#l103">103</a><td> * (defaults to false).<tr><td><a name="l104" href="#l104">104</a><td> * @param {SCOPE=} opt_listenerScope Object in whose scope to call the<tr><td><a name="l105" href="#l105">105</a><td> * listener.<tr><td><a name="l106" href="#l106">106</a><td> * @return {goog.events.ListenableKey} Unique key for the listener.<tr><td><a name="l107" href="#l107">107</a><td> * @template SCOPE,EVENTOBJ<tr><td><a name="l108" href="#l108">108</a><td> */<tr><td><a name="l109" href="#l109">109</a><td>goog.events.Listenable.prototype.listen;<tr><td><a name="l110" href="#l110">110</a><td><tr><td><a name="l111" href="#l111">111</a><td><tr><td><a name="l112" href="#l112">112</a><td>/**<tr><td><a name="l113" href="#l113">113</a><td> * Adds an event listener that is removed automatically after the<tr><td><a name="l114" href="#l114">114</a><td> * listener fired once.<tr><td><a name="l115" href="#l115">115</a><td> *<tr><td><a name="l116" href="#l116">116</a><td> * If an existing listener already exists, listenOnce will do<tr><td><a name="l117" href="#l117">117</a><td> * nothing. In particular, if the listener was previously registered<tr><td><a name="l118" href="#l118">118</a><td> * via listen(), listenOnce() will not turn the listener into a<tr><td><a name="l119" href="#l119">119</a><td> * one-off listener. Similarly, if there is already an existing<tr><td><a name="l120" href="#l120">120</a><td> * one-off listener, listenOnce does not modify the listeners (it is<tr><td><a name="l121" href="#l121">121</a><td> * still a once listener).<tr><td><a name="l122" href="#l122">122</a><td> *<tr><td><a name="l123" href="#l123">123</a><td> * @param {string|!goog.events.EventId.&lt;EVENTOBJ&gt;} type The event type id.<tr><td><a name="l124" href="#l124">124</a><td> * @param {function(this:SCOPE, EVENTOBJ):(boolean|undefined)} listener Callback<tr><td><a name="l125" href="#l125">125</a><td> * method.<tr><td><a name="l126" href="#l126">126</a><td> * @param {boolean=} opt_useCapture Whether to fire in capture phase<tr><td><a name="l127" href="#l127">127</a><td> * (defaults to false).<tr><td><a name="l128" href="#l128">128</a><td> * @param {SCOPE=} opt_listenerScope Object in whose scope to call the<tr><td><a name="l129" href="#l129">129</a><td> * listener.<tr><td><a name="l130" href="#l130">130</a><td> * @return {goog.events.ListenableKey} Unique key for the listener.<tr><td><a name="l131" href="#l131">131</a><td> * @template SCOPE,EVENTOBJ<tr><td><a name="l132" href="#l132">132</a><td> */<tr><td><a name="l133" href="#l133">133</a><td>goog.events.Listenable.prototype.listenOnce;<tr><td><a name="l134" href="#l134">134</a><td><tr><td><a name="l135" href="#l135">135</a><td><tr><td><a name="l136" href="#l136">136</a><td>/**<tr><td><a name="l137" href="#l137">137</a><td> * Removes an event listener which was added with listen() or listenOnce().<tr><td><a name="l138" href="#l138">138</a><td> *<tr><td><a name="l139" href="#l139">139</a><td> * @param {string|!goog.events.EventId.&lt;EVENTOBJ&gt;} type The event type id.<tr><td><a name="l140" href="#l140">140</a><td> * @param {function(this:SCOPE, EVENTOBJ):(boolean|undefined)} listener Callback<tr><td><a name="l141" href="#l141">141</a><td> * method.<tr><td><a name="l142" href="#l142">142</a><td> * @param {boolean=} opt_useCapture Whether to fire in capture phase<tr><td><a name="l143" href="#l143">143</a><td> * (defaults to false).<tr><td><a name="l144" href="#l144">144</a><td> * @param {SCOPE=} opt_listenerScope Object in whose scope to call<tr><td><a name="l145" href="#l145">145</a><td> * the listener.<tr><td><a name="l146" href="#l146">146</a><td> * @return {boolean} Whether any listener was removed.<tr><td><a name="l147" href="#l147">147</a><td> * @template SCOPE,EVENTOBJ<tr><td><a name="l148" href="#l148">148</a><td> */<tr><td><a name="l149" href="#l149">149</a><td>goog.events.Listenable.prototype.unlisten;<tr><td><a name="l150" href="#l150">150</a><td><tr><td><a name="l151" href="#l151">151</a><td><tr><td><a name="l152" href="#l152">152</a><td>/**<tr><td><a name="l153" href="#l153">153</a><td> * Removes an event listener which was added with listen() by the key<tr><td><a name="l154" href="#l154">154</a><td> * returned by listen().<tr><td><a name="l155" href="#l155">155</a><td> *<tr><td><a name="l156" href="#l156">156</a><td> * @param {goog.events.ListenableKey} key The key returned by<tr><td><a name="l157" href="#l157">157</a><td> * listen() or listenOnce().<tr><td><a name="l158" href="#l158">158</a><td> * @return {boolean} Whether any listener was removed.<tr><td><a name="l159" href="#l159">159</a><td> */<tr><td><a name="l160" href="#l160">160</a><td>goog.events.Listenable.prototype.unlistenByKey;<tr><td><a name="l161" href="#l161">161</a><td><tr><td><a name="l162" href="#l162">162</a><td><tr><td><a name="l163" href="#l163">163</a><td>/**<tr><td><a name="l164" href="#l164">164</a><td> * Dispatches an event (or event like object) and calls all listeners<tr><td><a name="l165" href="#l165">165</a><td> * listening for events of this type. The type of the event is decided by the<tr><td><a name="l166" href="#l166">166</a><td> * type property on the event object.<tr><td><a name="l167" href="#l167">167</a><td> *<tr><td><a name="l168" href="#l168">168</a><td> * If any of the listeners returns false OR calls preventDefault then this<tr><td><a name="l169" href="#l169">169</a><td> * function will return false. If one of the capture listeners calls<tr><td><a name="l170" href="#l170">170</a><td> * stopPropagation, then the bubble listeners won&#39;t fire.<tr><td><a name="l171" href="#l171">171</a><td> *<tr><td><a name="l172" href="#l172">172</a><td> * @param {goog.events.EventLike} e Event object.<tr><td><a name="l173" href="#l173">173</a><td> * @return {boolean} If anyone called preventDefault on the event object (or<tr><td><a name="l174" href="#l174">174</a><td> * if any of the listeners returns false) this will also return false.<tr><td><a name="l175" href="#l175">175</a><td> */<tr><td><a name="l176" href="#l176">176</a><td>goog.events.Listenable.prototype.dispatchEvent;<tr><td><a name="l177" href="#l177">177</a><td><tr><td><a name="l178" href="#l178">178</a><td><tr><td><a name="l179" href="#l179">179</a><td>/**<tr><td><a name="l180" href="#l180">180</a><td> * Removes all listeners from this listenable. If type is specified,<tr><td><a name="l181" href="#l181">181</a><td> * it will only remove listeners of the particular type. otherwise all<tr><td><a name="l182" href="#l182">182</a><td> * registered listeners will be removed.<tr><td><a name="l183" href="#l183">183</a><td> *<tr><td><a name="l184" href="#l184">184</a><td> * @param {string=} opt_type Type of event to remove, default is to<tr><td><a name="l185" href="#l185">185</a><td> * remove all types.<tr><td><a name="l186" href="#l186">186</a><td> * @return {number} Number of listeners removed.<tr><td><a name="l187" href="#l187">187</a><td> */<tr><td><a name="l188" href="#l188">188</a><td>goog.events.Listenable.prototype.removeAllListeners;<tr><td><a name="l189" href="#l189">189</a><td><tr><td><a name="l190" href="#l190">190</a><td><tr><td><a name="l191" href="#l191">191</a><td>/**<tr><td><a name="l192" href="#l192">192</a><td> * Returns the parent of this event target to use for capture/bubble<tr><td><a name="l193" href="#l193">193</a><td> * mechanism.<tr><td><a name="l194" href="#l194">194</a><td> *<tr><td><a name="l195" href="#l195">195</a><td> * NOTE(user): The name reflects the original implementation of<tr><td><a name="l196" href="#l196">196</a><td> * custom event target ({@code goog.events.EventTarget}). We decided<tr><td><a name="l197" href="#l197">197</a><td> * that changing the name is not worth it.<tr><td><a name="l198" href="#l198">198</a><td> *<tr><td><a name="l199" href="#l199">199</a><td> * @return {goog.events.Listenable} The parent EventTarget or null if<tr><td><a name="l200" href="#l200">200</a><td> * there is no parent.<tr><td><a name="l201" href="#l201">201</a><td> */<tr><td><a name="l202" href="#l202">202</a><td>goog.events.Listenable.prototype.getParentEventTarget;<tr><td><a name="l203" href="#l203">203</a><td><tr><td><a name="l204" href="#l204">204</a><td><tr><td><a name="l205" href="#l205">205</a><td>/**<tr><td><a name="l206" href="#l206">206</a><td> * Fires all registered listeners in this listenable for the given<tr><td><a name="l207" href="#l207">207</a><td> * type and capture mode, passing them the given eventObject. This<tr><td><a name="l208" href="#l208">208</a><td> * does not perform actual capture/bubble. Only implementors of the<tr><td><a name="l209" href="#l209">209</a><td> * interface should be using this.<tr><td><a name="l210" href="#l210">210</a><td> *<tr><td><a name="l211" href="#l211">211</a><td> * @param {string|!goog.events.EventId.&lt;EVENTOBJ&gt;} type The type of the<tr><td><a name="l212" href="#l212">212</a><td> * listeners to fire.<tr><td><a name="l213" href="#l213">213</a><td> * @param {boolean} capture The capture mode of the listeners to fire.<tr><td><a name="l214" href="#l214">214</a><td> * @param {EVENTOBJ} eventObject The event object to fire.<tr><td><a name="l215" href="#l215">215</a><td> * @return {boolean} Whether all listeners succeeded without<tr><td><a name="l216" href="#l216">216</a><td> * attempting to prevent default behavior. If any listener returns<tr><td><a name="l217" href="#l217">217</a><td> * false or called goog.events.Event#preventDefault, this returns<tr><td><a name="l218" href="#l218">218</a><td> * false.<tr><td><a name="l219" href="#l219">219</a><td> * @template EVENTOBJ<tr><td><a name="l220" href="#l220">220</a><td> */<tr><td><a name="l221" href="#l221">221</a><td>goog.events.Listenable.prototype.fireListeners;<tr><td><a name="l222" href="#l222">222</a><td><tr><td><a name="l223" href="#l223">223</a><td><tr><td><a name="l224" href="#l224">224</a><td>/**<tr><td><a name="l225" href="#l225">225</a><td> * Gets all listeners in this listenable for the given type and<tr><td><a name="l226" href="#l226">226</a><td> * capture mode.<tr><td><a name="l227" href="#l227">227</a><td> *<tr><td><a name="l228" href="#l228">228</a><td> * @param {string|!goog.events.EventId} type The type of the listeners to fire.<tr><td><a name="l229" href="#l229">229</a><td> * @param {boolean} capture The capture mode of the listeners to fire.<tr><td><a name="l230" href="#l230">230</a><td> * @return {!Array.&lt;goog.events.ListenableKey&gt;} An array of registered<tr><td><a name="l231" href="#l231">231</a><td> * listeners.<tr><td><a name="l232" href="#l232">232</a><td> * @template EVENTOBJ<tr><td><a name="l233" href="#l233">233</a><td> */<tr><td><a name="l234" href="#l234">234</a><td>goog.events.Listenable.prototype.getListeners;<tr><td><a name="l235" href="#l235">235</a><td><tr><td><a name="l236" href="#l236">236</a><td><tr><td><a name="l237" href="#l237">237</a><td>/**<tr><td><a name="l238" href="#l238">238</a><td> * Gets the goog.events.ListenableKey for the event or null if no such<tr><td><a name="l239" href="#l239">239</a><td> * listener is in use.<tr><td><a name="l240" href="#l240">240</a><td> *<tr><td><a name="l241" href="#l241">241</a><td> * @param {string|!goog.events.EventId.&lt;EVENTOBJ&gt;} type The name of the event<tr><td><a name="l242" href="#l242">242</a><td> * without the &#39;on&#39; prefix.<tr><td><a name="l243" href="#l243">243</a><td> * @param {function(this:SCOPE, EVENTOBJ):(boolean|undefined)} listener The<tr><td><a name="l244" href="#l244">244</a><td> * listener function to get.<tr><td><a name="l245" href="#l245">245</a><td> * @param {boolean} capture Whether the listener is a capturing listener.<tr><td><a name="l246" href="#l246">246</a><td> * @param {SCOPE=} opt_listenerScope Object in whose scope to call the<tr><td><a name="l247" href="#l247">247</a><td> * listener.<tr><td><a name="l248" href="#l248">248</a><td> * @return {goog.events.ListenableKey} the found listener or null if not found.<tr><td><a name="l249" href="#l249">249</a><td> * @template SCOPE,EVENTOBJ<tr><td><a name="l250" href="#l250">250</a><td> */<tr><td><a name="l251" href="#l251">251</a><td>goog.events.Listenable.prototype.getListener;<tr><td><a name="l252" href="#l252">252</a><td><tr><td><a name="l253" href="#l253">253</a><td><tr><td><a name="l254" href="#l254">254</a><td>/**<tr><td><a name="l255" href="#l255">255</a><td> * Whether there is any active listeners matching the specified<tr><td><a name="l256" href="#l256">256</a><td> * signature. If either the type or capture parameters are<tr><td><a name="l257" href="#l257">257</a><td> * unspecified, the function will match on the remaining criteria.<tr><td><a name="l258" href="#l258">258</a><td> *<tr><td><a name="l259" href="#l259">259</a><td> * @param {string|!goog.events.EventId.&lt;EVENTOBJ&gt;=} opt_type Event type.<tr><td><a name="l260" href="#l260">260</a><td> * @param {boolean=} opt_capture Whether to check for capture or bubble<tr><td><a name="l261" href="#l261">261</a><td> * listeners.<tr><td><a name="l262" href="#l262">262</a><td> * @return {boolean} Whether there is any active listeners matching<tr><td><a name="l263" href="#l263">263</a><td> * the requested type and/or capture phase.<tr><td><a name="l264" href="#l264">264</a><td> * @template EVENTOBJ<tr><td><a name="l265" href="#l265">265</a><td> */<tr><td><a name="l266" href="#l266">266</a><td>goog.events.Listenable.prototype.hasListener;<tr><td><a name="l267" href="#l267">267</a><td><tr><td><a name="l268" href="#l268">268</a><td><tr><td><a name="l269" href="#l269">269</a><td><tr><td><a name="l270" href="#l270">270</a><td>/**<tr><td><a name="l271" href="#l271">271</a><td> * An interface that describes a single registered listener.<tr><td><a name="l272" href="#l272">272</a><td> * @interface<tr><td><a name="l273" href="#l273">273</a><td> */<tr><td><a name="l274" href="#l274">274</a><td>goog.events.ListenableKey = function() {};<tr><td><a name="l275" href="#l275">275</a><td><tr><td><a name="l276" href="#l276">276</a><td><tr><td><a name="l277" href="#l277">277</a><td>/**<tr><td><a name="l278" href="#l278">278</a><td> * Counter used to create a unique key<tr><td><a name="l279" href="#l279">279</a><td> * @type {number}<tr><td><a name="l280" href="#l280">280</a><td> * @private<tr><td><a name="l281" href="#l281">281</a><td> */<tr><td><a name="l282" href="#l282">282</a><td>goog.events.ListenableKey.counter_ = 0;<tr><td><a name="l283" href="#l283">283</a><td><tr><td><a name="l284" href="#l284">284</a><td><tr><td><a name="l285" href="#l285">285</a><td>/**<tr><td><a name="l286" href="#l286">286</a><td> * Reserves a key to be used for ListenableKey#key field.<tr><td><a name="l287" href="#l287">287</a><td> * @return {number} A number to be used to fill ListenableKey#key<tr><td><a name="l288" href="#l288">288</a><td> * field.<tr><td><a name="l289" href="#l289">289</a><td> */<tr><td><a name="l290" href="#l290">290</a><td>goog.events.ListenableKey.reserveKey = function() {<tr><td><a name="l291" href="#l291">291</a><td> return ++goog.events.ListenableKey.counter_;<tr><td><a name="l292" href="#l292">292</a><td>};<tr><td><a name="l293" href="#l293">293</a><td><tr><td><a name="l294" href="#l294">294</a><td><tr><td><a name="l295" href="#l295">295</a><td>/**<tr><td><a name="l296" href="#l296">296</a><td> * The source event target.<tr><td><a name="l297" href="#l297">297</a><td> * @type {!(Object|goog.events.Listenable|goog.events.EventTarget)}<tr><td><a name="l298" href="#l298">298</a><td> */<tr><td><a name="l299" href="#l299">299</a><td>goog.events.ListenableKey.prototype.src;<tr><td><a name="l300" href="#l300">300</a><td><tr><td><a name="l301" href="#l301">301</a><td><tr><td><a name="l302" href="#l302">302</a><td>/**<tr><td><a name="l303" href="#l303">303</a><td> * The event type the listener is listening to.<tr><td><a name="l304" href="#l304">304</a><td> * @type {string}<tr><td><a name="l305" href="#l305">305</a><td> */<tr><td><a name="l306" href="#l306">306</a><td>goog.events.ListenableKey.prototype.type;<tr><td><a name="l307" href="#l307">307</a><td><tr><td><a name="l308" href="#l308">308</a><td><tr><td><a name="l309" href="#l309">309</a><td>/**<tr><td><a name="l310" href="#l310">310</a><td> * The listener function.<tr><td><a name="l311" href="#l311">311</a><td> * @type {function(?):?|{handleEvent:function(?):?}|null}<tr><td><a name="l312" href="#l312">312</a><td> */<tr><td><a name="l313" href="#l313">313</a><td>goog.events.ListenableKey.prototype.listener;<tr><td><a name="l314" href="#l314">314</a><td><tr><td><a name="l315" href="#l315">315</a><td><tr><td><a name="l316" href="#l316">316</a><td>/**<tr><td><a name="l317" href="#l317">317</a><td> * Whether the listener works on capture phase.<tr><td><a name="l318" href="#l318">318</a><td> * @type {boolean}<tr><td><a name="l319" href="#l319">319</a><td> */<tr><td><a name="l320" href="#l320">320</a><td>goog.events.ListenableKey.prototype.capture;<tr><td><a name="l321" href="#l321">321</a><td><tr><td><a name="l322" href="#l322">322</a><td><tr><td><a name="l323" href="#l323">323</a><td>/**<tr><td><a name="l324" href="#l324">324</a><td> * The &#39;this&#39; object for the listener function&#39;s scope.<tr><td><a name="l325" href="#l325">325</a><td> * @type {Object}<tr><td><a name="l326" href="#l326">326</a><td> */<tr><td><a name="l327" href="#l327">327</a><td>goog.events.ListenableKey.prototype.handler;<tr><td><a name="l328" href="#l328">328</a><td><tr><td><a name="l329" href="#l329">329</a><td><tr><td><a name="l330" href="#l330">330</a><td>/**<tr><td><a name="l331" href="#l331">331</a><td> * A globally unique number to identify the key.<tr><td><a name="l332" href="#l332">332</a><td> * @type {number}<tr><td><a name="l333" href="#l333">333</a><td> */<tr><td><a name="l334" href="#l334">334</a><td>goog.events.ListenableKey.prototype.key;</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="../../../../license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../../types.js"></script><script src="../../../../dossier.js"></script>
package/docs/source/lib/goog/events/listener.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>listener.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/events/listener.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2005 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Listener object.<tr><td><a name="l17" href="#l17">17</a><td> * @see ../demos/events.html<tr><td><a name="l18" href="#l18">18</a><td> */<tr><td><a name="l19" href="#l19">19</a><td><tr><td><a name="l20" href="#l20">20</a><td>goog.provide(&#39;goog.events.Listener&#39;);<tr><td><a name="l21" href="#l21">21</a><td><tr><td><a name="l22" href="#l22">22</a><td>goog.require(&#39;goog.events.ListenableKey&#39;);<tr><td><a name="l23" href="#l23">23</a><td><tr><td><a name="l24" href="#l24">24</a><td><tr><td><a name="l25" href="#l25">25</a><td><tr><td><a name="l26" href="#l26">26</a><td>/**<tr><td><a name="l27" href="#l27">27</a><td> * Simple class that stores information about a listener<tr><td><a name="l28" href="#l28">28</a><td> * @param {!Function} listener Callback function.<tr><td><a name="l29" href="#l29">29</a><td> * @param {Function} proxy Wrapper for the listener that patches the event.<tr><td><a name="l30" href="#l30">30</a><td> * @param {EventTarget|goog.events.Listenable} src Source object for<tr><td><a name="l31" href="#l31">31</a><td> * the event.<tr><td><a name="l32" href="#l32">32</a><td> * @param {string} type Event type.<tr><td><a name="l33" href="#l33">33</a><td> * @param {boolean} capture Whether in capture or bubble phase.<tr><td><a name="l34" href="#l34">34</a><td> * @param {Object=} opt_handler Object in whose context to execute the callback.<tr><td><a name="l35" href="#l35">35</a><td> * @implements {goog.events.ListenableKey}<tr><td><a name="l36" href="#l36">36</a><td> * @constructor<tr><td><a name="l37" href="#l37">37</a><td> */<tr><td><a name="l38" href="#l38">38</a><td>goog.events.Listener = function(<tr><td><a name="l39" href="#l39">39</a><td> listener, proxy, src, type, capture, opt_handler) {<tr><td><a name="l40" href="#l40">40</a><td> if (goog.events.Listener.ENABLE_MONITORING) {<tr><td><a name="l41" href="#l41">41</a><td> this.creationStack = new Error().stack;<tr><td><a name="l42" href="#l42">42</a><td> }<tr><td><a name="l43" href="#l43">43</a><td><tr><td><a name="l44" href="#l44">44</a><td> /**<tr><td><a name="l45" href="#l45">45</a><td> * Callback function.<tr><td><a name="l46" href="#l46">46</a><td> * @type {Function}<tr><td><a name="l47" href="#l47">47</a><td> */<tr><td><a name="l48" href="#l48">48</a><td> this.listener = listener;<tr><td><a name="l49" href="#l49">49</a><td><tr><td><a name="l50" href="#l50">50</a><td> /**<tr><td><a name="l51" href="#l51">51</a><td> * A wrapper over the original listener. This is used solely to<tr><td><a name="l52" href="#l52">52</a><td> * handle native browser events (it is used to simulate the capture<tr><td><a name="l53" href="#l53">53</a><td> * phase and to patch the event object).<tr><td><a name="l54" href="#l54">54</a><td> * @type {Function}<tr><td><a name="l55" href="#l55">55</a><td> */<tr><td><a name="l56" href="#l56">56</a><td> this.proxy = proxy;<tr><td><a name="l57" href="#l57">57</a><td><tr><td><a name="l58" href="#l58">58</a><td> /**<tr><td><a name="l59" href="#l59">59</a><td> * Object or node that callback is listening to<tr><td><a name="l60" href="#l60">60</a><td> * @type {EventTarget|goog.events.Listenable}<tr><td><a name="l61" href="#l61">61</a><td> */<tr><td><a name="l62" href="#l62">62</a><td> this.src = src;<tr><td><a name="l63" href="#l63">63</a><td><tr><td><a name="l64" href="#l64">64</a><td> /**<tr><td><a name="l65" href="#l65">65</a><td> * The event type.<tr><td><a name="l66" href="#l66">66</a><td> * @const {string}<tr><td><a name="l67" href="#l67">67</a><td> */<tr><td><a name="l68" href="#l68">68</a><td> this.type = type;<tr><td><a name="l69" href="#l69">69</a><td><tr><td><a name="l70" href="#l70">70</a><td> /**<tr><td><a name="l71" href="#l71">71</a><td> * Whether the listener is being called in the capture or bubble phase<tr><td><a name="l72" href="#l72">72</a><td> * @const {boolean}<tr><td><a name="l73" href="#l73">73</a><td> */<tr><td><a name="l74" href="#l74">74</a><td> this.capture = !!capture;<tr><td><a name="l75" href="#l75">75</a><td><tr><td><a name="l76" href="#l76">76</a><td> /**<tr><td><a name="l77" href="#l77">77</a><td> * Optional object whose context to execute the listener in<tr><td><a name="l78" href="#l78">78</a><td> * @type {Object|undefined}<tr><td><a name="l79" href="#l79">79</a><td> */<tr><td><a name="l80" href="#l80">80</a><td> this.handler = opt_handler;<tr><td><a name="l81" href="#l81">81</a><td><tr><td><a name="l82" href="#l82">82</a><td> /**<tr><td><a name="l83" href="#l83">83</a><td> * The key of the listener.<tr><td><a name="l84" href="#l84">84</a><td> * @const {number}<tr><td><a name="l85" href="#l85">85</a><td> * @override<tr><td><a name="l86" href="#l86">86</a><td> */<tr><td><a name="l87" href="#l87">87</a><td> this.key = goog.events.ListenableKey.reserveKey();<tr><td><a name="l88" href="#l88">88</a><td><tr><td><a name="l89" href="#l89">89</a><td> /**<tr><td><a name="l90" href="#l90">90</a><td> * Whether to remove the listener after it has been called.<tr><td><a name="l91" href="#l91">91</a><td> * @type {boolean}<tr><td><a name="l92" href="#l92">92</a><td> */<tr><td><a name="l93" href="#l93">93</a><td> this.callOnce = false;<tr><td><a name="l94" href="#l94">94</a><td><tr><td><a name="l95" href="#l95">95</a><td> /**<tr><td><a name="l96" href="#l96">96</a><td> * Whether the listener has been removed.<tr><td><a name="l97" href="#l97">97</a><td> * @type {boolean}<tr><td><a name="l98" href="#l98">98</a><td> */<tr><td><a name="l99" href="#l99">99</a><td> this.removed = false;<tr><td><a name="l100" href="#l100">100</a><td>};<tr><td><a name="l101" href="#l101">101</a><td><tr><td><a name="l102" href="#l102">102</a><td><tr><td><a name="l103" href="#l103">103</a><td>/**<tr><td><a name="l104" href="#l104">104</a><td> * @define {boolean} Whether to enable the monitoring of the<tr><td><a name="l105" href="#l105">105</a><td> * goog.events.Listener instances. Switching on the monitoring is only<tr><td><a name="l106" href="#l106">106</a><td> * recommended for debugging because it has a significant impact on<tr><td><a name="l107" href="#l107">107</a><td> * performance and memory usage. If switched off, the monitoring code<tr><td><a name="l108" href="#l108">108</a><td> * compiles down to 0 bytes.<tr><td><a name="l109" href="#l109">109</a><td> */<tr><td><a name="l110" href="#l110">110</a><td>goog.define(&#39;goog.events.Listener.ENABLE_MONITORING&#39;, false);<tr><td><a name="l111" href="#l111">111</a><td><tr><td><a name="l112" href="#l112">112</a><td><tr><td><a name="l113" href="#l113">113</a><td>/**<tr><td><a name="l114" href="#l114">114</a><td> * If monitoring the goog.events.Listener instances is enabled, stores the<tr><td><a name="l115" href="#l115">115</a><td> * creation stack trace of the Disposable instance.<tr><td><a name="l116" href="#l116">116</a><td> * @type {string}<tr><td><a name="l117" href="#l117">117</a><td> */<tr><td><a name="l118" href="#l118">118</a><td>goog.events.Listener.prototype.creationStack;<tr><td><a name="l119" href="#l119">119</a><td><tr><td><a name="l120" href="#l120">120</a><td><tr><td><a name="l121" href="#l121">121</a><td>/**<tr><td><a name="l122" href="#l122">122</a><td> * Marks this listener as removed. This also remove references held by<tr><td><a name="l123" href="#l123">123</a><td> * this listener object (such as listener and event source).<tr><td><a name="l124" href="#l124">124</a><td> */<tr><td><a name="l125" href="#l125">125</a><td>goog.events.Listener.prototype.markAsRemoved = function() {<tr><td><a name="l126" href="#l126">126</a><td> this.removed = true;<tr><td><a name="l127" href="#l127">127</a><td> this.listener = null;<tr><td><a name="l128" href="#l128">128</a><td> this.proxy = null;<tr><td><a name="l129" href="#l129">129</a><td> this.src = null;<tr><td><a name="l130" href="#l130">130</a><td> this.handler = null;<tr><td><a name="l131" href="#l131">131</a><td>};</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../../types.js"></script><script src="../../../../dossier.js"></script>
1
+ <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>listener.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/events/listener.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2005 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Listener object.<tr><td><a name="l17" href="#l17">17</a><td> * @see ../demos/events.html<tr><td><a name="l18" href="#l18">18</a><td> */<tr><td><a name="l19" href="#l19">19</a><td><tr><td><a name="l20" href="#l20">20</a><td>goog.provide(&#39;goog.events.Listener&#39;);<tr><td><a name="l21" href="#l21">21</a><td><tr><td><a name="l22" href="#l22">22</a><td>goog.require(&#39;goog.events.ListenableKey&#39;);<tr><td><a name="l23" href="#l23">23</a><td><tr><td><a name="l24" href="#l24">24</a><td><tr><td><a name="l25" href="#l25">25</a><td><tr><td><a name="l26" href="#l26">26</a><td>/**<tr><td><a name="l27" href="#l27">27</a><td> * Simple class that stores information about a listener<tr><td><a name="l28" href="#l28">28</a><td> * @param {!Function} listener Callback function.<tr><td><a name="l29" href="#l29">29</a><td> * @param {Function} proxy Wrapper for the listener that patches the event.<tr><td><a name="l30" href="#l30">30</a><td> * @param {EventTarget|goog.events.Listenable} src Source object for<tr><td><a name="l31" href="#l31">31</a><td> * the event.<tr><td><a name="l32" href="#l32">32</a><td> * @param {string} type Event type.<tr><td><a name="l33" href="#l33">33</a><td> * @param {boolean} capture Whether in capture or bubble phase.<tr><td><a name="l34" href="#l34">34</a><td> * @param {Object=} opt_handler Object in whose context to execute the callback.<tr><td><a name="l35" href="#l35">35</a><td> * @implements {goog.events.ListenableKey}<tr><td><a name="l36" href="#l36">36</a><td> * @constructor<tr><td><a name="l37" href="#l37">37</a><td> */<tr><td><a name="l38" href="#l38">38</a><td>goog.events.Listener = function(<tr><td><a name="l39" href="#l39">39</a><td> listener, proxy, src, type, capture, opt_handler) {<tr><td><a name="l40" href="#l40">40</a><td> if (goog.events.Listener.ENABLE_MONITORING) {<tr><td><a name="l41" href="#l41">41</a><td> this.creationStack = new Error().stack;<tr><td><a name="l42" href="#l42">42</a><td> }<tr><td><a name="l43" href="#l43">43</a><td><tr><td><a name="l44" href="#l44">44</a><td> /**<tr><td><a name="l45" href="#l45">45</a><td> * Callback function.<tr><td><a name="l46" href="#l46">46</a><td> * @type {Function}<tr><td><a name="l47" href="#l47">47</a><td> */<tr><td><a name="l48" href="#l48">48</a><td> this.listener = listener;<tr><td><a name="l49" href="#l49">49</a><td><tr><td><a name="l50" href="#l50">50</a><td> /**<tr><td><a name="l51" href="#l51">51</a><td> * A wrapper over the original listener. This is used solely to<tr><td><a name="l52" href="#l52">52</a><td> * handle native browser events (it is used to simulate the capture<tr><td><a name="l53" href="#l53">53</a><td> * phase and to patch the event object).<tr><td><a name="l54" href="#l54">54</a><td> * @type {Function}<tr><td><a name="l55" href="#l55">55</a><td> */<tr><td><a name="l56" href="#l56">56</a><td> this.proxy = proxy;<tr><td><a name="l57" href="#l57">57</a><td><tr><td><a name="l58" href="#l58">58</a><td> /**<tr><td><a name="l59" href="#l59">59</a><td> * Object or node that callback is listening to<tr><td><a name="l60" href="#l60">60</a><td> * @type {EventTarget|goog.events.Listenable}<tr><td><a name="l61" href="#l61">61</a><td> */<tr><td><a name="l62" href="#l62">62</a><td> this.src = src;<tr><td><a name="l63" href="#l63">63</a><td><tr><td><a name="l64" href="#l64">64</a><td> /**<tr><td><a name="l65" href="#l65">65</a><td> * The event type.<tr><td><a name="l66" href="#l66">66</a><td> * @const {string}<tr><td><a name="l67" href="#l67">67</a><td> */<tr><td><a name="l68" href="#l68">68</a><td> this.type = type;<tr><td><a name="l69" href="#l69">69</a><td><tr><td><a name="l70" href="#l70">70</a><td> /**<tr><td><a name="l71" href="#l71">71</a><td> * Whether the listener is being called in the capture or bubble phase<tr><td><a name="l72" href="#l72">72</a><td> * @const {boolean}<tr><td><a name="l73" href="#l73">73</a><td> */<tr><td><a name="l74" href="#l74">74</a><td> this.capture = !!capture;<tr><td><a name="l75" href="#l75">75</a><td><tr><td><a name="l76" href="#l76">76</a><td> /**<tr><td><a name="l77" href="#l77">77</a><td> * Optional object whose context to execute the listener in<tr><td><a name="l78" href="#l78">78</a><td> * @type {Object|undefined}<tr><td><a name="l79" href="#l79">79</a><td> */<tr><td><a name="l80" href="#l80">80</a><td> this.handler = opt_handler;<tr><td><a name="l81" href="#l81">81</a><td><tr><td><a name="l82" href="#l82">82</a><td> /**<tr><td><a name="l83" href="#l83">83</a><td> * The key of the listener.<tr><td><a name="l84" href="#l84">84</a><td> * @const {number}<tr><td><a name="l85" href="#l85">85</a><td> * @override<tr><td><a name="l86" href="#l86">86</a><td> */<tr><td><a name="l87" href="#l87">87</a><td> this.key = goog.events.ListenableKey.reserveKey();<tr><td><a name="l88" href="#l88">88</a><td><tr><td><a name="l89" href="#l89">89</a><td> /**<tr><td><a name="l90" href="#l90">90</a><td> * Whether to remove the listener after it has been called.<tr><td><a name="l91" href="#l91">91</a><td> * @type {boolean}<tr><td><a name="l92" href="#l92">92</a><td> */<tr><td><a name="l93" href="#l93">93</a><td> this.callOnce = false;<tr><td><a name="l94" href="#l94">94</a><td><tr><td><a name="l95" href="#l95">95</a><td> /**<tr><td><a name="l96" href="#l96">96</a><td> * Whether the listener has been removed.<tr><td><a name="l97" href="#l97">97</a><td> * @type {boolean}<tr><td><a name="l98" href="#l98">98</a><td> */<tr><td><a name="l99" href="#l99">99</a><td> this.removed = false;<tr><td><a name="l100" href="#l100">100</a><td>};<tr><td><a name="l101" href="#l101">101</a><td><tr><td><a name="l102" href="#l102">102</a><td><tr><td><a name="l103" href="#l103">103</a><td>/**<tr><td><a name="l104" href="#l104">104</a><td> * @define {boolean} Whether to enable the monitoring of the<tr><td><a name="l105" href="#l105">105</a><td> * goog.events.Listener instances. Switching on the monitoring is only<tr><td><a name="l106" href="#l106">106</a><td> * recommended for debugging because it has a significant impact on<tr><td><a name="l107" href="#l107">107</a><td> * performance and memory usage. If switched off, the monitoring code<tr><td><a name="l108" href="#l108">108</a><td> * compiles down to 0 bytes.<tr><td><a name="l109" href="#l109">109</a><td> */<tr><td><a name="l110" href="#l110">110</a><td>goog.define(&#39;goog.events.Listener.ENABLE_MONITORING&#39;, false);<tr><td><a name="l111" href="#l111">111</a><td><tr><td><a name="l112" href="#l112">112</a><td><tr><td><a name="l113" href="#l113">113</a><td>/**<tr><td><a name="l114" href="#l114">114</a><td> * If monitoring the goog.events.Listener instances is enabled, stores the<tr><td><a name="l115" href="#l115">115</a><td> * creation stack trace of the Disposable instance.<tr><td><a name="l116" href="#l116">116</a><td> * @type {string}<tr><td><a name="l117" href="#l117">117</a><td> */<tr><td><a name="l118" href="#l118">118</a><td>goog.events.Listener.prototype.creationStack;<tr><td><a name="l119" href="#l119">119</a><td><tr><td><a name="l120" href="#l120">120</a><td><tr><td><a name="l121" href="#l121">121</a><td>/**<tr><td><a name="l122" href="#l122">122</a><td> * Marks this listener as removed. This also remove references held by<tr><td><a name="l123" href="#l123">123</a><td> * this listener object (such as listener and event source).<tr><td><a name="l124" href="#l124">124</a><td> */<tr><td><a name="l125" href="#l125">125</a><td>goog.events.Listener.prototype.markAsRemoved = function() {<tr><td><a name="l126" href="#l126">126</a><td> this.removed = true;<tr><td><a name="l127" href="#l127">127</a><td> this.listener = null;<tr><td><a name="l128" href="#l128">128</a><td> this.proxy = null;<tr><td><a name="l129" href="#l129">129</a><td> this.src = null;<tr><td><a name="l130" href="#l130">130</a><td> this.handler = null;<tr><td><a name="l131" href="#l131">131</a><td>};</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="../../../../license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../../types.js"></script><script src="../../../../dossier.js"></script>