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/webdriver/http/xhrclient.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>xhrclient.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/webdriver/http/xhrclient.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2011 Software Freedom Conservancy. 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>/** @fileoverview A XHR client. */<tr><td><a name="l16" href="#l16">16</a><td><tr><td><a name="l17" href="#l17">17</a><td>goog.provide(&#39;webdriver.http.XhrClient&#39;);<tr><td><a name="l18" href="#l18">18</a><td><tr><td><a name="l19" href="#l19">19</a><td>goog.require(&#39;goog.json&#39;);<tr><td><a name="l20" href="#l20">20</a><td>goog.require(&#39;goog.net.XmlHttp&#39;);<tr><td><a name="l21" href="#l21">21</a><td>goog.require(&#39;webdriver.http.Response&#39;);<tr><td><a name="l22" href="#l22">22</a><td><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> * A HTTP client that sends requests using XMLHttpRequests.<tr><td><a name="l27" href="#l27">27</a><td> * @param {string} url URL for the WebDriver server to send commands to.<tr><td><a name="l28" href="#l28">28</a><td> * @constructor<tr><td><a name="l29" href="#l29">29</a><td> * @implements {webdriver.http.Client}<tr><td><a name="l30" href="#l30">30</a><td> */<tr><td><a name="l31" href="#l31">31</a><td>webdriver.http.XhrClient = function(url) {<tr><td><a name="l32" href="#l32">32</a><td><tr><td><a name="l33" href="#l33">33</a><td> /** @private {string} */<tr><td><a name="l34" href="#l34">34</a><td> this.url_ = url;<tr><td><a name="l35" href="#l35">35</a><td>};<tr><td><a name="l36" href="#l36">36</a><td><tr><td><a name="l37" href="#l37">37</a><td><tr><td><a name="l38" href="#l38">38</a><td>/** @override */<tr><td><a name="l39" href="#l39">39</a><td>webdriver.http.XhrClient.prototype.send = function(request, callback) {<tr><td><a name="l40" href="#l40">40</a><td> try {<tr><td><a name="l41" href="#l41">41</a><td> var xhr = /** @type {!XMLHttpRequest} */ (goog.net.XmlHttp());<tr><td><a name="l42" href="#l42">42</a><td> var url = this.url_ + request.path;<tr><td><a name="l43" href="#l43">43</a><td> xhr.open(request.method, url, true);<tr><td><a name="l44" href="#l44">44</a><td><tr><td><a name="l45" href="#l45">45</a><td> xhr.onload = function() {<tr><td><a name="l46" href="#l46">46</a><td> callback(null, webdriver.http.Response.fromXmlHttpRequest(xhr));<tr><td><a name="l47" href="#l47">47</a><td> };<tr><td><a name="l48" href="#l48">48</a><td><tr><td><a name="l49" href="#l49">49</a><td> xhr.onerror = function() {<tr><td><a name="l50" href="#l50">50</a><td> callback(Error([<tr><td><a name="l51" href="#l51">51</a><td> &#39;Unable to send request: &#39;, request.method, &#39; &#39;, url,<tr><td><a name="l52" href="#l52">52</a><td> &#39;\nOriginal request:\n&#39;, request<tr><td><a name="l53" href="#l53">53</a><td> ].join(&#39;&#39;)));<tr><td><a name="l54" href="#l54">54</a><td> };<tr><td><a name="l55" href="#l55">55</a><td><tr><td><a name="l56" href="#l56">56</a><td> for (var header in request.headers) {<tr><td><a name="l57" href="#l57">57</a><td> xhr.setRequestHeader(header, request.headers[header] + &#39;&#39;);<tr><td><a name="l58" href="#l58">58</a><td> }<tr><td><a name="l59" href="#l59">59</a><td><tr><td><a name="l60" href="#l60">60</a><td> xhr.send(goog.json.serialize(request.data));<tr><td><a name="l61" href="#l61">61</a><td> } catch (ex) {<tr><td><a name="l62" href="#l62">62</a><td> callback(ex);<tr><td><a name="l63" href="#l63">63</a><td> }<tr><td><a name="l64" href="#l64">64</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>xhrclient.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/webdriver/http/xhrclient.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2011 Software Freedom Conservancy. 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>/** @fileoverview A XHR client. */<tr><td><a name="l16" href="#l16">16</a><td><tr><td><a name="l17" href="#l17">17</a><td>goog.provide(&#39;webdriver.http.XhrClient&#39;);<tr><td><a name="l18" href="#l18">18</a><td><tr><td><a name="l19" href="#l19">19</a><td>goog.require(&#39;goog.json&#39;);<tr><td><a name="l20" href="#l20">20</a><td>goog.require(&#39;goog.net.XmlHttp&#39;);<tr><td><a name="l21" href="#l21">21</a><td>goog.require(&#39;webdriver.http.Response&#39;);<tr><td><a name="l22" href="#l22">22</a><td><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> * A HTTP client that sends requests using XMLHttpRequests.<tr><td><a name="l27" href="#l27">27</a><td> * @param {string} url URL for the WebDriver server to send commands to.<tr><td><a name="l28" href="#l28">28</a><td> * @constructor<tr><td><a name="l29" href="#l29">29</a><td> * @implements {webdriver.http.Client}<tr><td><a name="l30" href="#l30">30</a><td> */<tr><td><a name="l31" href="#l31">31</a><td>webdriver.http.XhrClient = function(url) {<tr><td><a name="l32" href="#l32">32</a><td><tr><td><a name="l33" href="#l33">33</a><td> /** @private {string} */<tr><td><a name="l34" href="#l34">34</a><td> this.url_ = url;<tr><td><a name="l35" href="#l35">35</a><td>};<tr><td><a name="l36" href="#l36">36</a><td><tr><td><a name="l37" href="#l37">37</a><td><tr><td><a name="l38" href="#l38">38</a><td>/** @override */<tr><td><a name="l39" href="#l39">39</a><td>webdriver.http.XhrClient.prototype.send = function(request, callback) {<tr><td><a name="l40" href="#l40">40</a><td> try {<tr><td><a name="l41" href="#l41">41</a><td> var xhr = /** @type {!XMLHttpRequest} */ (goog.net.XmlHttp());<tr><td><a name="l42" href="#l42">42</a><td> var url = this.url_ + request.path;<tr><td><a name="l43" href="#l43">43</a><td> xhr.open(request.method, url, true);<tr><td><a name="l44" href="#l44">44</a><td><tr><td><a name="l45" href="#l45">45</a><td> xhr.onload = function() {<tr><td><a name="l46" href="#l46">46</a><td> callback(null, webdriver.http.Response.fromXmlHttpRequest(xhr));<tr><td><a name="l47" href="#l47">47</a><td> };<tr><td><a name="l48" href="#l48">48</a><td><tr><td><a name="l49" href="#l49">49</a><td> xhr.onerror = function() {<tr><td><a name="l50" href="#l50">50</a><td> callback(Error([<tr><td><a name="l51" href="#l51">51</a><td> &#39;Unable to send request: &#39;, request.method, &#39; &#39;, url,<tr><td><a name="l52" href="#l52">52</a><td> &#39;\nOriginal request:\n&#39;, request<tr><td><a name="l53" href="#l53">53</a><td> ].join(&#39;&#39;)));<tr><td><a name="l54" href="#l54">54</a><td> };<tr><td><a name="l55" href="#l55">55</a><td><tr><td><a name="l56" href="#l56">56</a><td> for (var header in request.headers) {<tr><td><a name="l57" href="#l57">57</a><td> xhr.setRequestHeader(header, request.headers[header] + &#39;&#39;);<tr><td><a name="l58" href="#l58">58</a><td> }<tr><td><a name="l59" href="#l59">59</a><td><tr><td><a name="l60" href="#l60">60</a><td> xhr.send(goog.json.serialize(request.data));<tr><td><a name="l61" href="#l61">61</a><td> } catch (ex) {<tr><td><a name="l62" href="#l62">62</a><td> callback(ex);<tr><td><a name="l63" href="#l63">63</a><td> }<tr><td><a name="l64" href="#l64">64</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/webdriver/key.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>key.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/webdriver/key.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2012 Software Freedom Conservancy. 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>goog.provide(&#39;webdriver.Key&#39;);<tr><td><a name="l16" href="#l16">16</a><td><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> * Representations of pressable keys that aren&#39;t text. These are stored in<tr><td><a name="l20" href="#l20">20</a><td> * the Unicode PUA (Private Use Area) code points, 0xE000-0xF8FF. Refer to<tr><td><a name="l21" href="#l21">21</a><td> * http://www.google.com.au/search?&amp;q=unicode+pua&amp;btnG=Search<tr><td><a name="l22" href="#l22">22</a><td> *<tr><td><a name="l23" href="#l23">23</a><td> * @enum {string}<tr><td><a name="l24" href="#l24">24</a><td> */<tr><td><a name="l25" href="#l25">25</a><td>webdriver.Key = {<tr><td><a name="l26" href="#l26">26</a><td> NULL: &#39;\uE000&#39;,<tr><td><a name="l27" href="#l27">27</a><td> CANCEL: &#39;\uE001&#39;, // ^break<tr><td><a name="l28" href="#l28">28</a><td> HELP: &#39;\uE002&#39;,<tr><td><a name="l29" href="#l29">29</a><td> BACK_SPACE: &#39;\uE003&#39;,<tr><td><a name="l30" href="#l30">30</a><td> TAB: &#39;\uE004&#39;,<tr><td><a name="l31" href="#l31">31</a><td> CLEAR: &#39;\uE005&#39;,<tr><td><a name="l32" href="#l32">32</a><td> RETURN: &#39;\uE006&#39;,<tr><td><a name="l33" href="#l33">33</a><td> ENTER: &#39;\uE007&#39;,<tr><td><a name="l34" href="#l34">34</a><td> SHIFT: &#39;\uE008&#39;,<tr><td><a name="l35" href="#l35">35</a><td> CONTROL: &#39;\uE009&#39;,<tr><td><a name="l36" href="#l36">36</a><td> ALT: &#39;\uE00A&#39;,<tr><td><a name="l37" href="#l37">37</a><td> PAUSE: &#39;\uE00B&#39;,<tr><td><a name="l38" href="#l38">38</a><td> ESCAPE: &#39;\uE00C&#39;,<tr><td><a name="l39" href="#l39">39</a><td> SPACE: &#39;\uE00D&#39;,<tr><td><a name="l40" href="#l40">40</a><td> PAGE_UP: &#39;\uE00E&#39;,<tr><td><a name="l41" href="#l41">41</a><td> PAGE_DOWN: &#39;\uE00F&#39;,<tr><td><a name="l42" href="#l42">42</a><td> END: &#39;\uE010&#39;,<tr><td><a name="l43" href="#l43">43</a><td> HOME: &#39;\uE011&#39;,<tr><td><a name="l44" href="#l44">44</a><td> ARROW_LEFT: &#39;\uE012&#39;,<tr><td><a name="l45" href="#l45">45</a><td> LEFT: &#39;\uE012&#39;,<tr><td><a name="l46" href="#l46">46</a><td> ARROW_UP: &#39;\uE013&#39;,<tr><td><a name="l47" href="#l47">47</a><td> UP: &#39;\uE013&#39;,<tr><td><a name="l48" href="#l48">48</a><td> ARROW_RIGHT: &#39;\uE014&#39;,<tr><td><a name="l49" href="#l49">49</a><td> RIGHT: &#39;\uE014&#39;,<tr><td><a name="l50" href="#l50">50</a><td> ARROW_DOWN: &#39;\uE015&#39;,<tr><td><a name="l51" href="#l51">51</a><td> DOWN: &#39;\uE015&#39;,<tr><td><a name="l52" href="#l52">52</a><td> INSERT: &#39;\uE016&#39;,<tr><td><a name="l53" href="#l53">53</a><td> DELETE: &#39;\uE017&#39;,<tr><td><a name="l54" href="#l54">54</a><td> SEMICOLON: &#39;\uE018&#39;,<tr><td><a name="l55" href="#l55">55</a><td> EQUALS: &#39;\uE019&#39;,<tr><td><a name="l56" href="#l56">56</a><td><tr><td><a name="l57" href="#l57">57</a><td> NUMPAD0: &#39;\uE01A&#39;, // number pad keys<tr><td><a name="l58" href="#l58">58</a><td> NUMPAD1: &#39;\uE01B&#39;,<tr><td><a name="l59" href="#l59">59</a><td> NUMPAD2: &#39;\uE01C&#39;,<tr><td><a name="l60" href="#l60">60</a><td> NUMPAD3: &#39;\uE01D&#39;,<tr><td><a name="l61" href="#l61">61</a><td> NUMPAD4: &#39;\uE01E&#39;,<tr><td><a name="l62" href="#l62">62</a><td> NUMPAD5: &#39;\uE01F&#39;,<tr><td><a name="l63" href="#l63">63</a><td> NUMPAD6: &#39;\uE020&#39;,<tr><td><a name="l64" href="#l64">64</a><td> NUMPAD7: &#39;\uE021&#39;,<tr><td><a name="l65" href="#l65">65</a><td> NUMPAD8: &#39;\uE022&#39;,<tr><td><a name="l66" href="#l66">66</a><td> NUMPAD9: &#39;\uE023&#39;,<tr><td><a name="l67" href="#l67">67</a><td> MULTIPLY: &#39;\uE024&#39;,<tr><td><a name="l68" href="#l68">68</a><td> ADD: &#39;\uE025&#39;,<tr><td><a name="l69" href="#l69">69</a><td> SEPARATOR: &#39;\uE026&#39;,<tr><td><a name="l70" href="#l70">70</a><td> SUBTRACT: &#39;\uE027&#39;,<tr><td><a name="l71" href="#l71">71</a><td> DECIMAL: &#39;\uE028&#39;,<tr><td><a name="l72" href="#l72">72</a><td> DIVIDE: &#39;\uE029&#39;,<tr><td><a name="l73" href="#l73">73</a><td><tr><td><a name="l74" href="#l74">74</a><td> F1: &#39;\uE031&#39;, // function keys<tr><td><a name="l75" href="#l75">75</a><td> F2: &#39;\uE032&#39;,<tr><td><a name="l76" href="#l76">76</a><td> F3: &#39;\uE033&#39;,<tr><td><a name="l77" href="#l77">77</a><td> F4: &#39;\uE034&#39;,<tr><td><a name="l78" href="#l78">78</a><td> F5: &#39;\uE035&#39;,<tr><td><a name="l79" href="#l79">79</a><td> F6: &#39;\uE036&#39;,<tr><td><a name="l80" href="#l80">80</a><td> F7: &#39;\uE037&#39;,<tr><td><a name="l81" href="#l81">81</a><td> F8: &#39;\uE038&#39;,<tr><td><a name="l82" href="#l82">82</a><td> F9: &#39;\uE039&#39;,<tr><td><a name="l83" href="#l83">83</a><td> F10: &#39;\uE03A&#39;,<tr><td><a name="l84" href="#l84">84</a><td> F11: &#39;\uE03B&#39;,<tr><td><a name="l85" href="#l85">85</a><td> F12: &#39;\uE03C&#39;,<tr><td><a name="l86" href="#l86">86</a><td><tr><td><a name="l87" href="#l87">87</a><td> COMMAND: &#39;\uE03D&#39;, // Apple command key<tr><td><a name="l88" href="#l88">88</a><td> META: &#39;\uE03D&#39; // alias for Windows key<tr><td><a name="l89" href="#l89">89</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>key.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/webdriver/key.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2012 Software Freedom Conservancy. 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>goog.provide(&#39;webdriver.Key&#39;);<tr><td><a name="l16" href="#l16">16</a><td><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> * Representations of pressable keys that aren&#39;t text. These are stored in<tr><td><a name="l20" href="#l20">20</a><td> * the Unicode PUA (Private Use Area) code points, 0xE000-0xF8FF. Refer to<tr><td><a name="l21" href="#l21">21</a><td> * http://www.google.com.au/search?&amp;q=unicode+pua&amp;btnG=Search<tr><td><a name="l22" href="#l22">22</a><td> *<tr><td><a name="l23" href="#l23">23</a><td> * @enum {string}<tr><td><a name="l24" href="#l24">24</a><td> */<tr><td><a name="l25" href="#l25">25</a><td>webdriver.Key = {<tr><td><a name="l26" href="#l26">26</a><td> NULL: &#39;\uE000&#39;,<tr><td><a name="l27" href="#l27">27</a><td> CANCEL: &#39;\uE001&#39;, // ^break<tr><td><a name="l28" href="#l28">28</a><td> HELP: &#39;\uE002&#39;,<tr><td><a name="l29" href="#l29">29</a><td> BACK_SPACE: &#39;\uE003&#39;,<tr><td><a name="l30" href="#l30">30</a><td> TAB: &#39;\uE004&#39;,<tr><td><a name="l31" href="#l31">31</a><td> CLEAR: &#39;\uE005&#39;,<tr><td><a name="l32" href="#l32">32</a><td> RETURN: &#39;\uE006&#39;,<tr><td><a name="l33" href="#l33">33</a><td> ENTER: &#39;\uE007&#39;,<tr><td><a name="l34" href="#l34">34</a><td> SHIFT: &#39;\uE008&#39;,<tr><td><a name="l35" href="#l35">35</a><td> CONTROL: &#39;\uE009&#39;,<tr><td><a name="l36" href="#l36">36</a><td> ALT: &#39;\uE00A&#39;,<tr><td><a name="l37" href="#l37">37</a><td> PAUSE: &#39;\uE00B&#39;,<tr><td><a name="l38" href="#l38">38</a><td> ESCAPE: &#39;\uE00C&#39;,<tr><td><a name="l39" href="#l39">39</a><td> SPACE: &#39;\uE00D&#39;,<tr><td><a name="l40" href="#l40">40</a><td> PAGE_UP: &#39;\uE00E&#39;,<tr><td><a name="l41" href="#l41">41</a><td> PAGE_DOWN: &#39;\uE00F&#39;,<tr><td><a name="l42" href="#l42">42</a><td> END: &#39;\uE010&#39;,<tr><td><a name="l43" href="#l43">43</a><td> HOME: &#39;\uE011&#39;,<tr><td><a name="l44" href="#l44">44</a><td> ARROW_LEFT: &#39;\uE012&#39;,<tr><td><a name="l45" href="#l45">45</a><td> LEFT: &#39;\uE012&#39;,<tr><td><a name="l46" href="#l46">46</a><td> ARROW_UP: &#39;\uE013&#39;,<tr><td><a name="l47" href="#l47">47</a><td> UP: &#39;\uE013&#39;,<tr><td><a name="l48" href="#l48">48</a><td> ARROW_RIGHT: &#39;\uE014&#39;,<tr><td><a name="l49" href="#l49">49</a><td> RIGHT: &#39;\uE014&#39;,<tr><td><a name="l50" href="#l50">50</a><td> ARROW_DOWN: &#39;\uE015&#39;,<tr><td><a name="l51" href="#l51">51</a><td> DOWN: &#39;\uE015&#39;,<tr><td><a name="l52" href="#l52">52</a><td> INSERT: &#39;\uE016&#39;,<tr><td><a name="l53" href="#l53">53</a><td> DELETE: &#39;\uE017&#39;,<tr><td><a name="l54" href="#l54">54</a><td> SEMICOLON: &#39;\uE018&#39;,<tr><td><a name="l55" href="#l55">55</a><td> EQUALS: &#39;\uE019&#39;,<tr><td><a name="l56" href="#l56">56</a><td><tr><td><a name="l57" href="#l57">57</a><td> NUMPAD0: &#39;\uE01A&#39;, // number pad keys<tr><td><a name="l58" href="#l58">58</a><td> NUMPAD1: &#39;\uE01B&#39;,<tr><td><a name="l59" href="#l59">59</a><td> NUMPAD2: &#39;\uE01C&#39;,<tr><td><a name="l60" href="#l60">60</a><td> NUMPAD3: &#39;\uE01D&#39;,<tr><td><a name="l61" href="#l61">61</a><td> NUMPAD4: &#39;\uE01E&#39;,<tr><td><a name="l62" href="#l62">62</a><td> NUMPAD5: &#39;\uE01F&#39;,<tr><td><a name="l63" href="#l63">63</a><td> NUMPAD6: &#39;\uE020&#39;,<tr><td><a name="l64" href="#l64">64</a><td> NUMPAD7: &#39;\uE021&#39;,<tr><td><a name="l65" href="#l65">65</a><td> NUMPAD8: &#39;\uE022&#39;,<tr><td><a name="l66" href="#l66">66</a><td> NUMPAD9: &#39;\uE023&#39;,<tr><td><a name="l67" href="#l67">67</a><td> MULTIPLY: &#39;\uE024&#39;,<tr><td><a name="l68" href="#l68">68</a><td> ADD: &#39;\uE025&#39;,<tr><td><a name="l69" href="#l69">69</a><td> SEPARATOR: &#39;\uE026&#39;,<tr><td><a name="l70" href="#l70">70</a><td> SUBTRACT: &#39;\uE027&#39;,<tr><td><a name="l71" href="#l71">71</a><td> DECIMAL: &#39;\uE028&#39;,<tr><td><a name="l72" href="#l72">72</a><td> DIVIDE: &#39;\uE029&#39;,<tr><td><a name="l73" href="#l73">73</a><td><tr><td><a name="l74" href="#l74">74</a><td> F1: &#39;\uE031&#39;, // function keys<tr><td><a name="l75" href="#l75">75</a><td> F2: &#39;\uE032&#39;,<tr><td><a name="l76" href="#l76">76</a><td> F3: &#39;\uE033&#39;,<tr><td><a name="l77" href="#l77">77</a><td> F4: &#39;\uE034&#39;,<tr><td><a name="l78" href="#l78">78</a><td> F5: &#39;\uE035&#39;,<tr><td><a name="l79" href="#l79">79</a><td> F6: &#39;\uE036&#39;,<tr><td><a name="l80" href="#l80">80</a><td> F7: &#39;\uE037&#39;,<tr><td><a name="l81" href="#l81">81</a><td> F8: &#39;\uE038&#39;,<tr><td><a name="l82" href="#l82">82</a><td> F9: &#39;\uE039&#39;,<tr><td><a name="l83" href="#l83">83</a><td> F10: &#39;\uE03A&#39;,<tr><td><a name="l84" href="#l84">84</a><td> F11: &#39;\uE03B&#39;,<tr><td><a name="l85" href="#l85">85</a><td> F12: &#39;\uE03C&#39;,<tr><td><a name="l86" href="#l86">86</a><td><tr><td><a name="l87" href="#l87">87</a><td> COMMAND: &#39;\uE03D&#39;, // Apple command key<tr><td><a name="l88" href="#l88">88</a><td> META: &#39;\uE03D&#39; // alias for Windows key<tr><td><a name="l89" href="#l89">89</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/webdriver/locators.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>locators.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/webdriver/locators.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2011 Software Freedom Conservancy. 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 Factory methods for the supported locator strategies.<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;webdriver.By&#39;);<tr><td><a name="l20" href="#l20">20</a><td>goog.provide(&#39;webdriver.Locator&#39;);<tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;webdriver.Locator.Strategy&#39;);<tr><td><a name="l22" href="#l22">22</a><td><tr><td><a name="l23" href="#l23">23</a><td>goog.require(&#39;goog.array&#39;);<tr><td><a name="l24" href="#l24">24</a><td>goog.require(&#39;goog.object&#39;);<tr><td><a name="l25" href="#l25">25</a><td>goog.require(&#39;goog.string&#39;);<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><tr><td><a name="l29" href="#l29">29</a><td>/**<tr><td><a name="l30" href="#l30">30</a><td> * An element locator.<tr><td><a name="l31" href="#l31">31</a><td> * @param {string} using The type of strategy to use for this locator.<tr><td><a name="l32" href="#l32">32</a><td> * @param {string} value The search target of this locator.<tr><td><a name="l33" href="#l33">33</a><td> * @constructor<tr><td><a name="l34" href="#l34">34</a><td> */<tr><td><a name="l35" href="#l35">35</a><td>webdriver.Locator = function(using, value) {<tr><td><a name="l36" href="#l36">36</a><td><tr><td><a name="l37" href="#l37">37</a><td> /**<tr><td><a name="l38" href="#l38">38</a><td> * The search strategy to use when searching for an element.<tr><td><a name="l39" href="#l39">39</a><td> * @type {string}<tr><td><a name="l40" href="#l40">40</a><td> */<tr><td><a name="l41" href="#l41">41</a><td> this.using = using;<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> * The search target for this locator.<tr><td><a name="l45" href="#l45">45</a><td> * @type {string}<tr><td><a name="l46" href="#l46">46</a><td> */<tr><td><a name="l47" href="#l47">47</a><td> this.value = value;<tr><td><a name="l48" href="#l48">48</a><td>};<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>/**<tr><td><a name="l52" href="#l52">52</a><td> * Creates a factory function for a {@link webdriver.Locator}.<tr><td><a name="l53" href="#l53">53</a><td> * @param {string} type The type of locator for the factory.<tr><td><a name="l54" href="#l54">54</a><td> * @return {function(string): !webdriver.Locator} The new factory function.<tr><td><a name="l55" href="#l55">55</a><td> * @private<tr><td><a name="l56" href="#l56">56</a><td> */<tr><td><a name="l57" href="#l57">57</a><td>webdriver.Locator.factory_ = function(type) {<tr><td><a name="l58" href="#l58">58</a><td> return function(value) {<tr><td><a name="l59" href="#l59">59</a><td> return new webdriver.Locator(type, value);<tr><td><a name="l60" href="#l60">60</a><td> };<tr><td><a name="l61" href="#l61">61</a><td>};<tr><td><a name="l62" href="#l62">62</a><td><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> * A collection of factory functions for creating {@link webdriver.Locator}<tr><td><a name="l66" href="#l66">66</a><td> * instances.<tr><td><a name="l67" href="#l67">67</a><td> */<tr><td><a name="l68" href="#l68">68</a><td>webdriver.By = {};<tr><td><a name="l69" href="#l69">69</a><td>// Exported to the global scope for legacy reasons.<tr><td><a name="l70" href="#l70">70</a><td>goog.exportSymbol(&#39;By&#39;, webdriver.By);<tr><td><a name="l71" href="#l71">71</a><td><tr><td><a name="l72" href="#l72">72</a><td><tr><td><a name="l73" href="#l73">73</a><td>/**<tr><td><a name="l74" href="#l74">74</a><td> * Short-hand expressions for the primary element locator strategies.<tr><td><a name="l75" href="#l75">75</a><td> * For example the following two statements are equivalent:<tr><td><a name="l76" href="#l76">76</a><td> * &lt;code&gt;&lt;pre&gt;<tr><td><a name="l77" href="#l77">77</a><td> * var e1 = driver.findElement(webdriver.By.id(&#39;foo&#39;));<tr><td><a name="l78" href="#l78">78</a><td> * var e2 = driver.findElement({id: &#39;foo&#39;});<tr><td><a name="l79" href="#l79">79</a><td> * &lt;/pre&gt;&lt;/code&gt;<tr><td><a name="l80" href="#l80">80</a><td> *<tr><td><a name="l81" href="#l81">81</a><td> * &lt;p&gt;Care should be taken when using JavaScript minifiers (such as the<tr><td><a name="l82" href="#l82">82</a><td> * Closure compiler), as locator hashes will always be parsed using<tr><td><a name="l83" href="#l83">83</a><td> * the un-obfuscated properties listed below.<tr><td><a name="l84" href="#l84">84</a><td> *<tr><td><a name="l85" href="#l85">85</a><td> * @typedef {(<tr><td><a name="l86" href="#l86">86</a><td> * {className: string}|<tr><td><a name="l87" href="#l87">87</a><td> * {css: string}|<tr><td><a name="l88" href="#l88">88</a><td> * {id: string}|<tr><td><a name="l89" href="#l89">89</a><td> * {js: string}|<tr><td><a name="l90" href="#l90">90</a><td> * {linkText: string}|<tr><td><a name="l91" href="#l91">91</a><td> * {name: string}|<tr><td><a name="l92" href="#l92">92</a><td> * {partialLinkText: string}|<tr><td><a name="l93" href="#l93">93</a><td> * {tagName: string}|<tr><td><a name="l94" href="#l94">94</a><td> * {xpath: string})}<tr><td><a name="l95" href="#l95">95</a><td> */<tr><td><a name="l96" href="#l96">96</a><td>webdriver.By.Hash;<tr><td><a name="l97" href="#l97">97</a><td><tr><td><a name="l98" href="#l98">98</a><td><tr><td><a name="l99" href="#l99">99</a><td>/**<tr><td><a name="l100" href="#l100">100</a><td> * Locates elements that have a specific class name. The returned locator<tr><td><a name="l101" href="#l101">101</a><td> * is equivalent to searching for elements with the CSS selector &quot;.clazz&quot;.<tr><td><a name="l102" href="#l102">102</a><td> *<tr><td><a name="l103" href="#l103">103</a><td> * @param {string} className The class name to search for.<tr><td><a name="l104" href="#l104">104</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l105" href="#l105">105</a><td> * @see http://www.w3.org/TR/2011/WD-html5-20110525/elements.html#classes<tr><td><a name="l106" href="#l106">106</a><td> * @see http://www.w3.org/TR/CSS2/selector.html#class-html<tr><td><a name="l107" href="#l107">107</a><td> */<tr><td><a name="l108" href="#l108">108</a><td>webdriver.By.className = webdriver.Locator.factory_(&#39;class name&#39;);<tr><td><a name="l109" href="#l109">109</a><td><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> * Locates elements using a CSS selector. For browsers that do not support<tr><td><a name="l113" href="#l113">113</a><td> * CSS selectors, WebDriver implementations may return an<tr><td><a name="l114" href="#l114">114</a><td> * {@link bot.Error.State.INVALID_SELECTOR invalid selector} error. An<tr><td><a name="l115" href="#l115">115</a><td> * implementation may, however, emulate the CSS selector API.<tr><td><a name="l116" href="#l116">116</a><td> *<tr><td><a name="l117" href="#l117">117</a><td> * @param {string} selector The CSS selector to use.<tr><td><a name="l118" href="#l118">118</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l119" href="#l119">119</a><td> * @see http://www.w3.org/TR/CSS2/selector.html<tr><td><a name="l120" href="#l120">120</a><td> */<tr><td><a name="l121" href="#l121">121</a><td>webdriver.By.css = webdriver.Locator.factory_(&#39;css selector&#39;);<tr><td><a name="l122" href="#l122">122</a><td><tr><td><a name="l123" href="#l123">123</a><td><tr><td><a name="l124" href="#l124">124</a><td>/**<tr><td><a name="l125" href="#l125">125</a><td> * Locates an element by its ID.<tr><td><a name="l126" href="#l126">126</a><td> *<tr><td><a name="l127" href="#l127">127</a><td> * @param {string} id The ID to search for.<tr><td><a name="l128" href="#l128">128</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l129" href="#l129">129</a><td> */<tr><td><a name="l130" href="#l130">130</a><td>webdriver.By.id = webdriver.Locator.factory_(&#39;id&#39;);<tr><td><a name="l131" href="#l131">131</a><td><tr><td><a name="l132" href="#l132">132</a><td><tr><td><a name="l133" href="#l133">133</a><td>/**<tr><td><a name="l134" href="#l134">134</a><td> * Locates link elements whose {@link webdriver.WebElement#getText visible<tr><td><a name="l135" href="#l135">135</a><td> * text} matches the given string.<tr><td><a name="l136" href="#l136">136</a><td> *<tr><td><a name="l137" href="#l137">137</a><td> * @param {string} text The link text to search for.<tr><td><a name="l138" href="#l138">138</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l139" href="#l139">139</a><td> */<tr><td><a name="l140" href="#l140">140</a><td>webdriver.By.linkText = webdriver.Locator.factory_(&#39;link text&#39;);<tr><td><a name="l141" href="#l141">141</a><td><tr><td><a name="l142" href="#l142">142</a><td><tr><td><a name="l143" href="#l143">143</a><td>/**<tr><td><a name="l144" href="#l144">144</a><td> * Locates an elements by evaluating a<tr><td><a name="l145" href="#l145">145</a><td> * {@link webdriver.WebDriver#executeScript JavaScript expression}.<tr><td><a name="l146" href="#l146">146</a><td> * The result of this expression must be an element or list of elements.<tr><td><a name="l147" href="#l147">147</a><td> *<tr><td><a name="l148" href="#l148">148</a><td> * @param {!(string|Function)} script The script to execute.<tr><td><a name="l149" href="#l149">149</a><td> * @param {...*} var_args The arguments to pass to the script.<tr><td><a name="l150" href="#l150">150</a><td> * @return {function(!webdriver.WebDriver): !webdriver.promise.Promise} A new,<tr><td><a name="l151" href="#l151">151</a><td> * JavaScript-based locator function.<tr><td><a name="l152" href="#l152">152</a><td> */<tr><td><a name="l153" href="#l153">153</a><td>webdriver.By.js = function(script, var_args) {<tr><td><a name="l154" href="#l154">154</a><td> var args = goog.array.slice(arguments, 0);<tr><td><a name="l155" href="#l155">155</a><td> return function(driver) {<tr><td><a name="l156" href="#l156">156</a><td> return driver.executeScript.apply(driver, args);<tr><td><a name="l157" href="#l157">157</a><td> };<tr><td><a name="l158" href="#l158">158</a><td>};<tr><td><a name="l159" href="#l159">159</a><td><tr><td><a name="l160" href="#l160">160</a><td><tr><td><a name="l161" href="#l161">161</a><td>/**<tr><td><a name="l162" href="#l162">162</a><td> * Locates elements whose {@code name} attribute has the given value.<tr><td><a name="l163" href="#l163">163</a><td> *<tr><td><a name="l164" href="#l164">164</a><td> * @param {string} name The name attribute to search for.<tr><td><a name="l165" href="#l165">165</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l166" href="#l166">166</a><td> */<tr><td><a name="l167" href="#l167">167</a><td>webdriver.By.name = webdriver.Locator.factory_(&#39;name&#39;);<tr><td><a name="l168" href="#l168">168</a><td><tr><td><a name="l169" href="#l169">169</a><td><tr><td><a name="l170" href="#l170">170</a><td>/**<tr><td><a name="l171" href="#l171">171</a><td> * Locates link elements whose {@link webdriver.WebElement#getText visible<tr><td><a name="l172" href="#l172">172</a><td> * text} contains the given substring.<tr><td><a name="l173" href="#l173">173</a><td> *<tr><td><a name="l174" href="#l174">174</a><td> * @param {string} text The substring to check for in a link&#39;s visible text.<tr><td><a name="l175" href="#l175">175</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l176" href="#l176">176</a><td> */<tr><td><a name="l177" href="#l177">177</a><td>webdriver.By.partialLinkText = webdriver.Locator.factory_(<tr><td><a name="l178" href="#l178">178</a><td> &#39;partial link text&#39;);<tr><td><a name="l179" href="#l179">179</a><td><tr><td><a name="l180" href="#l180">180</a><td><tr><td><a name="l181" href="#l181">181</a><td>/**<tr><td><a name="l182" href="#l182">182</a><td> * Locates elements with a given tag name. The returned locator is<tr><td><a name="l183" href="#l183">183</a><td> * equivalent to using the {@code getElementsByTagName} DOM function.<tr><td><a name="l184" href="#l184">184</a><td> *<tr><td><a name="l185" href="#l185">185</a><td> * @param {string} text The substring to check for in a link&#39;s visible text.<tr><td><a name="l186" href="#l186">186</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l187" href="#l187">187</a><td> * @see http://www.w3.org/TR/REC-DOM-Level-1/level-one-core.html<tr><td><a name="l188" href="#l188">188</a><td> */<tr><td><a name="l189" href="#l189">189</a><td>webdriver.By.tagName = webdriver.Locator.factory_(&#39;tag name&#39;);<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>/**<tr><td><a name="l193" href="#l193">193</a><td> * Locates elements matching a XPath selector. Care should be taken when<tr><td><a name="l194" href="#l194">194</a><td> * using an XPath selector with a {@link webdriver.WebElement} as WebDriver<tr><td><a name="l195" href="#l195">195</a><td> * will respect the context in the specified in the selector. For example,<tr><td><a name="l196" href="#l196">196</a><td> * given the selector {@code &quot;//div&quot;}, WebDriver will search from the<tr><td><a name="l197" href="#l197">197</a><td> * document root regardless of whether the locator was used with a<tr><td><a name="l198" href="#l198">198</a><td> * WebElement.<tr><td><a name="l199" href="#l199">199</a><td> *<tr><td><a name="l200" href="#l200">200</a><td> * @param {string} xpath The XPath selector to use.<tr><td><a name="l201" href="#l201">201</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l202" href="#l202">202</a><td> * @see http://www.w3.org/TR/xpath/<tr><td><a name="l203" href="#l203">203</a><td> */<tr><td><a name="l204" href="#l204">204</a><td>webdriver.By.xpath = webdriver.Locator.factory_(&#39;xpath&#39;);<tr><td><a name="l205" href="#l205">205</a><td><tr><td><a name="l206" href="#l206">206</a><td><tr><td><a name="l207" href="#l207">207</a><td>/**<tr><td><a name="l208" href="#l208">208</a><td> * Maps {@link webdriver.By.Hash} keys to the appropriate factory function.<tr><td><a name="l209" href="#l209">209</a><td> * @type {!Object.&lt;string, function(string): !(Function|webdriver.Locator)&gt;}<tr><td><a name="l210" href="#l210">210</a><td> * @const<tr><td><a name="l211" href="#l211">211</a><td> */<tr><td><a name="l212" href="#l212">212</a><td>webdriver.Locator.Strategy = {<tr><td><a name="l213" href="#l213">213</a><td> &#39;className&#39;: webdriver.By.className,<tr><td><a name="l214" href="#l214">214</a><td> &#39;css&#39;: webdriver.By.css,<tr><td><a name="l215" href="#l215">215</a><td> &#39;id&#39;: webdriver.By.id,<tr><td><a name="l216" href="#l216">216</a><td> &#39;js&#39;: webdriver.By.js,<tr><td><a name="l217" href="#l217">217</a><td> &#39;linkText&#39;: webdriver.By.linkText,<tr><td><a name="l218" href="#l218">218</a><td> &#39;name&#39;: webdriver.By.name,<tr><td><a name="l219" href="#l219">219</a><td> &#39;partialLinkText&#39;: webdriver.By.partialLinkText,<tr><td><a name="l220" href="#l220">220</a><td> &#39;tagName&#39;: webdriver.By.tagName,<tr><td><a name="l221" href="#l221">221</a><td> &#39;xpath&#39;: webdriver.By.xpath<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>/**<tr><td><a name="l226" href="#l226">226</a><td> * Verifies that a {@code value} is a valid locator to use for searching for<tr><td><a name="l227" href="#l227">227</a><td> * elements on the page.<tr><td><a name="l228" href="#l228">228</a><td> *<tr><td><a name="l229" href="#l229">229</a><td> * @param {*} value The value to check is a valid locator.<tr><td><a name="l230" href="#l230">230</a><td> * @return {!(webdriver.Locator|Function)} A valid locator object or function.<tr><td><a name="l231" href="#l231">231</a><td> * @throws {TypeError} If the given value is an invalid locator.<tr><td><a name="l232" href="#l232">232</a><td> */<tr><td><a name="l233" href="#l233">233</a><td>webdriver.Locator.checkLocator = function(value) {<tr><td><a name="l234" href="#l234">234</a><td> if (goog.isFunction(value) || value instanceof webdriver.Locator) {<tr><td><a name="l235" href="#l235">235</a><td> return value;<tr><td><a name="l236" href="#l236">236</a><td> }<tr><td><a name="l237" href="#l237">237</a><td> for (var key in value) {<tr><td><a name="l238" href="#l238">238</a><td> if (value.hasOwnProperty(key) &amp;&amp;<tr><td><a name="l239" href="#l239">239</a><td> webdriver.Locator.Strategy.hasOwnProperty(key)) {<tr><td><a name="l240" href="#l240">240</a><td> return webdriver.Locator.Strategy[key](value[key]);<tr><td><a name="l241" href="#l241">241</a><td> }<tr><td><a name="l242" href="#l242">242</a><td> }<tr><td><a name="l243" href="#l243">243</a><td> throw new TypeError(&#39;Invalid locator&#39;);<tr><td><a name="l244" href="#l244">244</a><td>};<tr><td><a name="l245" href="#l245">245</a><td><tr><td><a name="l246" href="#l246">246</a><td><tr><td><a name="l247" href="#l247">247</a><td><tr><td><a name="l248" href="#l248">248</a><td>/** @override */<tr><td><a name="l249" href="#l249">249</a><td>webdriver.Locator.prototype.toString = function() {<tr><td><a name="l250" href="#l250">250</a><td> return &#39;By.&#39; + this.using.replace(/ ([a-z])/g, function(all, match) {<tr><td><a name="l251" href="#l251">251</a><td> return match.toUpperCase();<tr><td><a name="l252" href="#l252">252</a><td> }) + &#39;(&#39; + goog.string.quote(this.value) + &#39;)&#39;;<tr><td><a name="l253" href="#l253">253</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>locators.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/webdriver/locators.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2011 Software Freedom Conservancy. 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 Factory methods for the supported locator strategies.<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;webdriver.By&#39;);<tr><td><a name="l20" href="#l20">20</a><td>goog.provide(&#39;webdriver.Locator&#39;);<tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;webdriver.Locator.Strategy&#39;);<tr><td><a name="l22" href="#l22">22</a><td><tr><td><a name="l23" href="#l23">23</a><td>goog.require(&#39;goog.array&#39;);<tr><td><a name="l24" href="#l24">24</a><td>goog.require(&#39;goog.object&#39;);<tr><td><a name="l25" href="#l25">25</a><td>goog.require(&#39;goog.string&#39;);<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><tr><td><a name="l29" href="#l29">29</a><td>/**<tr><td><a name="l30" href="#l30">30</a><td> * An element locator.<tr><td><a name="l31" href="#l31">31</a><td> * @param {string} using The type of strategy to use for this locator.<tr><td><a name="l32" href="#l32">32</a><td> * @param {string} value The search target of this locator.<tr><td><a name="l33" href="#l33">33</a><td> * @constructor<tr><td><a name="l34" href="#l34">34</a><td> */<tr><td><a name="l35" href="#l35">35</a><td>webdriver.Locator = function(using, value) {<tr><td><a name="l36" href="#l36">36</a><td><tr><td><a name="l37" href="#l37">37</a><td> /**<tr><td><a name="l38" href="#l38">38</a><td> * The search strategy to use when searching for an element.<tr><td><a name="l39" href="#l39">39</a><td> * @type {string}<tr><td><a name="l40" href="#l40">40</a><td> */<tr><td><a name="l41" href="#l41">41</a><td> this.using = using;<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> * The search target for this locator.<tr><td><a name="l45" href="#l45">45</a><td> * @type {string}<tr><td><a name="l46" href="#l46">46</a><td> */<tr><td><a name="l47" href="#l47">47</a><td> this.value = value;<tr><td><a name="l48" href="#l48">48</a><td>};<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>/**<tr><td><a name="l52" href="#l52">52</a><td> * Creates a factory function for a {@link webdriver.Locator}.<tr><td><a name="l53" href="#l53">53</a><td> * @param {string} type The type of locator for the factory.<tr><td><a name="l54" href="#l54">54</a><td> * @return {function(string): !webdriver.Locator} The new factory function.<tr><td><a name="l55" href="#l55">55</a><td> * @private<tr><td><a name="l56" href="#l56">56</a><td> */<tr><td><a name="l57" href="#l57">57</a><td>webdriver.Locator.factory_ = function(type) {<tr><td><a name="l58" href="#l58">58</a><td> return function(value) {<tr><td><a name="l59" href="#l59">59</a><td> return new webdriver.Locator(type, value);<tr><td><a name="l60" href="#l60">60</a><td> };<tr><td><a name="l61" href="#l61">61</a><td>};<tr><td><a name="l62" href="#l62">62</a><td><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> * A collection of factory functions for creating {@link webdriver.Locator}<tr><td><a name="l66" href="#l66">66</a><td> * instances.<tr><td><a name="l67" href="#l67">67</a><td> */<tr><td><a name="l68" href="#l68">68</a><td>webdriver.By = {};<tr><td><a name="l69" href="#l69">69</a><td>// Exported to the global scope for legacy reasons.<tr><td><a name="l70" href="#l70">70</a><td>goog.exportSymbol(&#39;By&#39;, webdriver.By);<tr><td><a name="l71" href="#l71">71</a><td><tr><td><a name="l72" href="#l72">72</a><td><tr><td><a name="l73" href="#l73">73</a><td>/**<tr><td><a name="l74" href="#l74">74</a><td> * Short-hand expressions for the primary element locator strategies.<tr><td><a name="l75" href="#l75">75</a><td> * For example the following two statements are equivalent:<tr><td><a name="l76" href="#l76">76</a><td> * &lt;code&gt;&lt;pre&gt;<tr><td><a name="l77" href="#l77">77</a><td> * var e1 = driver.findElement(webdriver.By.id(&#39;foo&#39;));<tr><td><a name="l78" href="#l78">78</a><td> * var e2 = driver.findElement({id: &#39;foo&#39;});<tr><td><a name="l79" href="#l79">79</a><td> * &lt;/pre&gt;&lt;/code&gt;<tr><td><a name="l80" href="#l80">80</a><td> *<tr><td><a name="l81" href="#l81">81</a><td> * &lt;p&gt;Care should be taken when using JavaScript minifiers (such as the<tr><td><a name="l82" href="#l82">82</a><td> * Closure compiler), as locator hashes will always be parsed using<tr><td><a name="l83" href="#l83">83</a><td> * the un-obfuscated properties listed below.<tr><td><a name="l84" href="#l84">84</a><td> *<tr><td><a name="l85" href="#l85">85</a><td> * @typedef {(<tr><td><a name="l86" href="#l86">86</a><td> * {className: string}|<tr><td><a name="l87" href="#l87">87</a><td> * {css: string}|<tr><td><a name="l88" href="#l88">88</a><td> * {id: string}|<tr><td><a name="l89" href="#l89">89</a><td> * {js: string}|<tr><td><a name="l90" href="#l90">90</a><td> * {linkText: string}|<tr><td><a name="l91" href="#l91">91</a><td> * {name: string}|<tr><td><a name="l92" href="#l92">92</a><td> * {partialLinkText: string}|<tr><td><a name="l93" href="#l93">93</a><td> * {tagName: string}|<tr><td><a name="l94" href="#l94">94</a><td> * {xpath: string})}<tr><td><a name="l95" href="#l95">95</a><td> */<tr><td><a name="l96" href="#l96">96</a><td>webdriver.By.Hash;<tr><td><a name="l97" href="#l97">97</a><td><tr><td><a name="l98" href="#l98">98</a><td><tr><td><a name="l99" href="#l99">99</a><td>/**<tr><td><a name="l100" href="#l100">100</a><td> * Locates elements that have a specific class name. The returned locator<tr><td><a name="l101" href="#l101">101</a><td> * is equivalent to searching for elements with the CSS selector &quot;.clazz&quot;.<tr><td><a name="l102" href="#l102">102</a><td> *<tr><td><a name="l103" href="#l103">103</a><td> * @param {string} className The class name to search for.<tr><td><a name="l104" href="#l104">104</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l105" href="#l105">105</a><td> * @see http://www.w3.org/TR/2011/WD-html5-20110525/elements.html#classes<tr><td><a name="l106" href="#l106">106</a><td> * @see http://www.w3.org/TR/CSS2/selector.html#class-html<tr><td><a name="l107" href="#l107">107</a><td> */<tr><td><a name="l108" href="#l108">108</a><td>webdriver.By.className = webdriver.Locator.factory_(&#39;class name&#39;);<tr><td><a name="l109" href="#l109">109</a><td><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> * Locates elements using a CSS selector. For browsers that do not support<tr><td><a name="l113" href="#l113">113</a><td> * CSS selectors, WebDriver implementations may return an<tr><td><a name="l114" href="#l114">114</a><td> * {@link bot.Error.State.INVALID_SELECTOR invalid selector} error. An<tr><td><a name="l115" href="#l115">115</a><td> * implementation may, however, emulate the CSS selector API.<tr><td><a name="l116" href="#l116">116</a><td> *<tr><td><a name="l117" href="#l117">117</a><td> * @param {string} selector The CSS selector to use.<tr><td><a name="l118" href="#l118">118</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l119" href="#l119">119</a><td> * @see http://www.w3.org/TR/CSS2/selector.html<tr><td><a name="l120" href="#l120">120</a><td> */<tr><td><a name="l121" href="#l121">121</a><td>webdriver.By.css = webdriver.Locator.factory_(&#39;css selector&#39;);<tr><td><a name="l122" href="#l122">122</a><td><tr><td><a name="l123" href="#l123">123</a><td><tr><td><a name="l124" href="#l124">124</a><td>/**<tr><td><a name="l125" href="#l125">125</a><td> * Locates an element by its ID.<tr><td><a name="l126" href="#l126">126</a><td> *<tr><td><a name="l127" href="#l127">127</a><td> * @param {string} id The ID to search for.<tr><td><a name="l128" href="#l128">128</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l129" href="#l129">129</a><td> */<tr><td><a name="l130" href="#l130">130</a><td>webdriver.By.id = webdriver.Locator.factory_(&#39;id&#39;);<tr><td><a name="l131" href="#l131">131</a><td><tr><td><a name="l132" href="#l132">132</a><td><tr><td><a name="l133" href="#l133">133</a><td>/**<tr><td><a name="l134" href="#l134">134</a><td> * Locates link elements whose {@link webdriver.WebElement#getText visible<tr><td><a name="l135" href="#l135">135</a><td> * text} matches the given string.<tr><td><a name="l136" href="#l136">136</a><td> *<tr><td><a name="l137" href="#l137">137</a><td> * @param {string} text The link text to search for.<tr><td><a name="l138" href="#l138">138</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l139" href="#l139">139</a><td> */<tr><td><a name="l140" href="#l140">140</a><td>webdriver.By.linkText = webdriver.Locator.factory_(&#39;link text&#39;);<tr><td><a name="l141" href="#l141">141</a><td><tr><td><a name="l142" href="#l142">142</a><td><tr><td><a name="l143" href="#l143">143</a><td>/**<tr><td><a name="l144" href="#l144">144</a><td> * Locates an elements by evaluating a<tr><td><a name="l145" href="#l145">145</a><td> * {@link webdriver.WebDriver#executeScript JavaScript expression}.<tr><td><a name="l146" href="#l146">146</a><td> * The result of this expression must be an element or list of elements.<tr><td><a name="l147" href="#l147">147</a><td> *<tr><td><a name="l148" href="#l148">148</a><td> * @param {!(string|Function)} script The script to execute.<tr><td><a name="l149" href="#l149">149</a><td> * @param {...*} var_args The arguments to pass to the script.<tr><td><a name="l150" href="#l150">150</a><td> * @return {function(!webdriver.WebDriver): !webdriver.promise.Promise} A new,<tr><td><a name="l151" href="#l151">151</a><td> * JavaScript-based locator function.<tr><td><a name="l152" href="#l152">152</a><td> */<tr><td><a name="l153" href="#l153">153</a><td>webdriver.By.js = function(script, var_args) {<tr><td><a name="l154" href="#l154">154</a><td> var args = goog.array.slice(arguments, 0);<tr><td><a name="l155" href="#l155">155</a><td> return function(driver) {<tr><td><a name="l156" href="#l156">156</a><td> return driver.executeScript.apply(driver, args);<tr><td><a name="l157" href="#l157">157</a><td> };<tr><td><a name="l158" href="#l158">158</a><td>};<tr><td><a name="l159" href="#l159">159</a><td><tr><td><a name="l160" href="#l160">160</a><td><tr><td><a name="l161" href="#l161">161</a><td>/**<tr><td><a name="l162" href="#l162">162</a><td> * Locates elements whose {@code name} attribute has the given value.<tr><td><a name="l163" href="#l163">163</a><td> *<tr><td><a name="l164" href="#l164">164</a><td> * @param {string} name The name attribute to search for.<tr><td><a name="l165" href="#l165">165</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l166" href="#l166">166</a><td> */<tr><td><a name="l167" href="#l167">167</a><td>webdriver.By.name = webdriver.Locator.factory_(&#39;name&#39;);<tr><td><a name="l168" href="#l168">168</a><td><tr><td><a name="l169" href="#l169">169</a><td><tr><td><a name="l170" href="#l170">170</a><td>/**<tr><td><a name="l171" href="#l171">171</a><td> * Locates link elements whose {@link webdriver.WebElement#getText visible<tr><td><a name="l172" href="#l172">172</a><td> * text} contains the given substring.<tr><td><a name="l173" href="#l173">173</a><td> *<tr><td><a name="l174" href="#l174">174</a><td> * @param {string} text The substring to check for in a link&#39;s visible text.<tr><td><a name="l175" href="#l175">175</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l176" href="#l176">176</a><td> */<tr><td><a name="l177" href="#l177">177</a><td>webdriver.By.partialLinkText = webdriver.Locator.factory_(<tr><td><a name="l178" href="#l178">178</a><td> &#39;partial link text&#39;);<tr><td><a name="l179" href="#l179">179</a><td><tr><td><a name="l180" href="#l180">180</a><td><tr><td><a name="l181" href="#l181">181</a><td>/**<tr><td><a name="l182" href="#l182">182</a><td> * Locates elements with a given tag name. The returned locator is<tr><td><a name="l183" href="#l183">183</a><td> * equivalent to using the {@code getElementsByTagName} DOM function.<tr><td><a name="l184" href="#l184">184</a><td> *<tr><td><a name="l185" href="#l185">185</a><td> * @param {string} text The substring to check for in a link&#39;s visible text.<tr><td><a name="l186" href="#l186">186</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l187" href="#l187">187</a><td> * @see http://www.w3.org/TR/REC-DOM-Level-1/level-one-core.html<tr><td><a name="l188" href="#l188">188</a><td> */<tr><td><a name="l189" href="#l189">189</a><td>webdriver.By.tagName = webdriver.Locator.factory_(&#39;tag name&#39;);<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>/**<tr><td><a name="l193" href="#l193">193</a><td> * Locates elements matching a XPath selector. Care should be taken when<tr><td><a name="l194" href="#l194">194</a><td> * using an XPath selector with a {@link webdriver.WebElement} as WebDriver<tr><td><a name="l195" href="#l195">195</a><td> * will respect the context in the specified in the selector. For example,<tr><td><a name="l196" href="#l196">196</a><td> * given the selector {@code &quot;//div&quot;}, WebDriver will search from the<tr><td><a name="l197" href="#l197">197</a><td> * document root regardless of whether the locator was used with a<tr><td><a name="l198" href="#l198">198</a><td> * WebElement.<tr><td><a name="l199" href="#l199">199</a><td> *<tr><td><a name="l200" href="#l200">200</a><td> * @param {string} xpath The XPath selector to use.<tr><td><a name="l201" href="#l201">201</a><td> * @return {!webdriver.Locator} The new locator.<tr><td><a name="l202" href="#l202">202</a><td> * @see http://www.w3.org/TR/xpath/<tr><td><a name="l203" href="#l203">203</a><td> */<tr><td><a name="l204" href="#l204">204</a><td>webdriver.By.xpath = webdriver.Locator.factory_(&#39;xpath&#39;);<tr><td><a name="l205" href="#l205">205</a><td><tr><td><a name="l206" href="#l206">206</a><td><tr><td><a name="l207" href="#l207">207</a><td>/**<tr><td><a name="l208" href="#l208">208</a><td> * Maps {@link webdriver.By.Hash} keys to the appropriate factory function.<tr><td><a name="l209" href="#l209">209</a><td> * @type {!Object.&lt;string, function(string): !(Function|webdriver.Locator)&gt;}<tr><td><a name="l210" href="#l210">210</a><td> * @const<tr><td><a name="l211" href="#l211">211</a><td> */<tr><td><a name="l212" href="#l212">212</a><td>webdriver.Locator.Strategy = {<tr><td><a name="l213" href="#l213">213</a><td> &#39;className&#39;: webdriver.By.className,<tr><td><a name="l214" href="#l214">214</a><td> &#39;css&#39;: webdriver.By.css,<tr><td><a name="l215" href="#l215">215</a><td> &#39;id&#39;: webdriver.By.id,<tr><td><a name="l216" href="#l216">216</a><td> &#39;js&#39;: webdriver.By.js,<tr><td><a name="l217" href="#l217">217</a><td> &#39;linkText&#39;: webdriver.By.linkText,<tr><td><a name="l218" href="#l218">218</a><td> &#39;name&#39;: webdriver.By.name,<tr><td><a name="l219" href="#l219">219</a><td> &#39;partialLinkText&#39;: webdriver.By.partialLinkText,<tr><td><a name="l220" href="#l220">220</a><td> &#39;tagName&#39;: webdriver.By.tagName,<tr><td><a name="l221" href="#l221">221</a><td> &#39;xpath&#39;: webdriver.By.xpath<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>/**<tr><td><a name="l226" href="#l226">226</a><td> * Verifies that a {@code value} is a valid locator to use for searching for<tr><td><a name="l227" href="#l227">227</a><td> * elements on the page.<tr><td><a name="l228" href="#l228">228</a><td> *<tr><td><a name="l229" href="#l229">229</a><td> * @param {*} value The value to check is a valid locator.<tr><td><a name="l230" href="#l230">230</a><td> * @return {!(webdriver.Locator|Function)} A valid locator object or function.<tr><td><a name="l231" href="#l231">231</a><td> * @throws {TypeError} If the given value is an invalid locator.<tr><td><a name="l232" href="#l232">232</a><td> */<tr><td><a name="l233" href="#l233">233</a><td>webdriver.Locator.checkLocator = function(value) {<tr><td><a name="l234" href="#l234">234</a><td> if (goog.isFunction(value) || value instanceof webdriver.Locator) {<tr><td><a name="l235" href="#l235">235</a><td> return value;<tr><td><a name="l236" href="#l236">236</a><td> }<tr><td><a name="l237" href="#l237">237</a><td> for (var key in value) {<tr><td><a name="l238" href="#l238">238</a><td> if (value.hasOwnProperty(key) &amp;&amp;<tr><td><a name="l239" href="#l239">239</a><td> webdriver.Locator.Strategy.hasOwnProperty(key)) {<tr><td><a name="l240" href="#l240">240</a><td> return webdriver.Locator.Strategy[key](value[key]);<tr><td><a name="l241" href="#l241">241</a><td> }<tr><td><a name="l242" href="#l242">242</a><td> }<tr><td><a name="l243" href="#l243">243</a><td> throw new TypeError(&#39;Invalid locator&#39;);<tr><td><a name="l244" href="#l244">244</a><td>};<tr><td><a name="l245" href="#l245">245</a><td><tr><td><a name="l246" href="#l246">246</a><td><tr><td><a name="l247" href="#l247">247</a><td><tr><td><a name="l248" href="#l248">248</a><td>/** @override */<tr><td><a name="l249" href="#l249">249</a><td>webdriver.Locator.prototype.toString = function() {<tr><td><a name="l250" href="#l250">250</a><td> return &#39;By.&#39; + this.using.replace(/ ([a-z])/g, function(all, match) {<tr><td><a name="l251" href="#l251">251</a><td> return match.toUpperCase();<tr><td><a name="l252" href="#l252">252</a><td> }) + &#39;(&#39; + goog.string.quote(this.value) + &#39;)&#39;;<tr><td><a name="l253" href="#l253">253</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/webdriver/logging.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>logging.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/webdriver/logging.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2013 Selenium comitters<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2013 Software Freedom Conservancy<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>goog.provide(&#39;webdriver.logging&#39;);<tr><td><a name="l17" href="#l17">17</a><td>goog.provide(&#39;webdriver.logging.Preferences&#39;);<tr><td><a name="l18" href="#l18">18</a><td><tr><td><a name="l19" href="#l19">19</a><td>goog.require(&#39;goog.object&#39;);<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>/**<tr><td><a name="l23" href="#l23">23</a><td> * Logging levels.<tr><td><a name="l24" href="#l24">24</a><td> * @enum {{value: number, name: string}}<tr><td><a name="l25" href="#l25">25</a><td> */<tr><td><a name="l26" href="#l26">26</a><td>webdriver.logging.Level = {<tr><td><a name="l27" href="#l27">27</a><td> ALL: {value: Number.MIN_VALUE, name: &#39;ALL&#39;},<tr><td><a name="l28" href="#l28">28</a><td> DEBUG: {value: 700, name: &#39;DEBUG&#39;},<tr><td><a name="l29" href="#l29">29</a><td> INFO: {value: 800, name: &#39;INFO&#39;},<tr><td><a name="l30" href="#l30">30</a><td> WARNING: {value: 900, name: &#39;WARNING&#39;},<tr><td><a name="l31" href="#l31">31</a><td> SEVERE: {value: 1000, name: &#39;SEVERE&#39;},<tr><td><a name="l32" href="#l32">32</a><td> OFF: {value: Number.MAX_VALUE, name: &#39;OFF&#39;}<tr><td><a name="l33" href="#l33">33</a><td>};<tr><td><a name="l34" href="#l34">34</a><td><tr><td><a name="l35" href="#l35">35</a><td><tr><td><a name="l36" href="#l36">36</a><td>/**<tr><td><a name="l37" href="#l37">37</a><td> * Converts a level name or value to a {@link webdriver.logging.Level} value.<tr><td><a name="l38" href="#l38">38</a><td> * If the name/value is not recognized, {@link webdriver.logging.Level.ALL}<tr><td><a name="l39" href="#l39">39</a><td> * will be returned.<tr><td><a name="l40" href="#l40">40</a><td> * @param {(number|string)} nameOrValue The log level name, or value, to<tr><td><a name="l41" href="#l41">41</a><td> * convert .<tr><td><a name="l42" href="#l42">42</a><td> * @return {!webdriver.logging.Level} The converted level.<tr><td><a name="l43" href="#l43">43</a><td> */<tr><td><a name="l44" href="#l44">44</a><td>webdriver.logging.getLevel = function(nameOrValue) {<tr><td><a name="l45" href="#l45">45</a><td> var predicate = goog.isString(nameOrValue) ?<tr><td><a name="l46" href="#l46">46</a><td> function(val) { return val.name === nameOrValue; } :<tr><td><a name="l47" href="#l47">47</a><td> function(val) { return val.value === nameOrValue; };<tr><td><a name="l48" href="#l48">48</a><td><tr><td><a name="l49" href="#l49">49</a><td> return goog.object.findValue(webdriver.logging.Level, predicate) ||<tr><td><a name="l50" href="#l50">50</a><td> webdriver.logging.Level.ALL;<tr><td><a name="l51" href="#l51">51</a><td>};<tr><td><a name="l52" href="#l52">52</a><td><tr><td><a name="l53" href="#l53">53</a><td><tr><td><a name="l54" href="#l54">54</a><td>/**<tr><td><a name="l55" href="#l55">55</a><td> * Common log types.<tr><td><a name="l56" href="#l56">56</a><td> * @enum {string}<tr><td><a name="l57" href="#l57">57</a><td> */<tr><td><a name="l58" href="#l58">58</a><td>webdriver.logging.Type = {<tr><td><a name="l59" href="#l59">59</a><td> /** Logs originating from the browser. */<tr><td><a name="l60" href="#l60">60</a><td> BROWSER: &#39;browser&#39;,<tr><td><a name="l61" href="#l61">61</a><td> /** Logs from a WebDriver client. */<tr><td><a name="l62" href="#l62">62</a><td> CLIENT: &#39;client&#39;,<tr><td><a name="l63" href="#l63">63</a><td> /** Logs from a WebDriver implementation. */<tr><td><a name="l64" href="#l64">64</a><td> DRIVER: &#39;driver&#39;,<tr><td><a name="l65" href="#l65">65</a><td> /** Logs related to performance. */<tr><td><a name="l66" href="#l66">66</a><td> PERFORMANCE: &#39;performance&#39;,<tr><td><a name="l67" href="#l67">67</a><td> /** Logs from the remote server. */<tr><td><a name="l68" href="#l68">68</a><td> SERVER: &#39;server&#39;<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><tr><td><a name="l72" href="#l72">72</a><td>/**<tr><td><a name="l73" href="#l73">73</a><td> * Describes the log preferences for a WebDriver session.<tr><td><a name="l74" href="#l74">74</a><td> * @constructor<tr><td><a name="l75" href="#l75">75</a><td> */<tr><td><a name="l76" href="#l76">76</a><td>webdriver.logging.Preferences = function() {<tr><td><a name="l77" href="#l77">77</a><td> /** @private {!Object.&lt;string, webdriver.logging.Level&gt;} */<tr><td><a name="l78" href="#l78">78</a><td> this.prefs_ = {};<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> * Sets the desired logging level for a particular log type.<tr><td><a name="l84" href="#l84">84</a><td> * @param {(string|webdriver.logging.Type)} type The log type.<tr><td><a name="l85" href="#l85">85</a><td> * @param {!webdriver.logging.Level} level The desired log level.<tr><td><a name="l86" href="#l86">86</a><td> */<tr><td><a name="l87" href="#l87">87</a><td>webdriver.logging.Preferences.prototype.setLevel = function(type, level) {<tr><td><a name="l88" href="#l88">88</a><td> this.prefs_[type] = level;<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> * Converts this instance to its JSON representation.<tr><td><a name="l94" href="#l94">94</a><td> * @return {!Object.&lt;string, string&gt;} The JSON representation of this set of<tr><td><a name="l95" href="#l95">95</a><td> * preferences.<tr><td><a name="l96" href="#l96">96</a><td> */<tr><td><a name="l97" href="#l97">97</a><td>webdriver.logging.Preferences.prototype.toJSON = function() {<tr><td><a name="l98" href="#l98">98</a><td> var obj = {};<tr><td><a name="l99" href="#l99">99</a><td> for (var type in this.prefs_) {<tr><td><a name="l100" href="#l100">100</a><td> if (this.prefs_.hasOwnProperty(type)) {<tr><td><a name="l101" href="#l101">101</a><td> obj[type] = this.prefs_[type].name;<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> return obj;<tr><td><a name="l105" href="#l105">105</a><td>};<tr><td><a name="l106" href="#l106">106</a><td><tr><td><a name="l107" href="#l107">107</a><td><tr><td><a name="l108" href="#l108">108</a><td>/**<tr><td><a name="l109" href="#l109">109</a><td> * A single log entry.<tr><td><a name="l110" href="#l110">110</a><td> * @param {(!webdriver.logging.Level|string)} level The entry level.<tr><td><a name="l111" href="#l111">111</a><td> * @param {string} message The log message.<tr><td><a name="l112" href="#l112">112</a><td> * @param {number=} opt_timestamp The time this entry was generated, in<tr><td><a name="l113" href="#l113">113</a><td> * milliseconds since 0:00:00, January 1, 1970 UTC. If omitted, the<tr><td><a name="l114" href="#l114">114</a><td> * current time will be used.<tr><td><a name="l115" href="#l115">115</a><td> * @param {string=} opt_type The log type, if known.<tr><td><a name="l116" href="#l116">116</a><td> * @constructor<tr><td><a name="l117" href="#l117">117</a><td> */<tr><td><a name="l118" href="#l118">118</a><td>webdriver.logging.Entry = function(level, message, opt_timestamp, opt_type) {<tr><td><a name="l119" href="#l119">119</a><td><tr><td><a name="l120" href="#l120">120</a><td> /** @type {!webdriver.logging.Level} */<tr><td><a name="l121" href="#l121">121</a><td> this.level =<tr><td><a name="l122" href="#l122">122</a><td> goog.isString(level) ? webdriver.logging.getLevel(level) : level;<tr><td><a name="l123" href="#l123">123</a><td><tr><td><a name="l124" href="#l124">124</a><td> /** @type {string} */<tr><td><a name="l125" href="#l125">125</a><td> this.message = message;<tr><td><a name="l126" href="#l126">126</a><td><tr><td><a name="l127" href="#l127">127</a><td> /** @type {number} */<tr><td><a name="l128" href="#l128">128</a><td> this.timestamp = goog.isNumber(opt_timestamp) ? opt_timestamp : goog.now();<tr><td><a name="l129" href="#l129">129</a><td><tr><td><a name="l130" href="#l130">130</a><td> /** @type {string} */<tr><td><a name="l131" href="#l131">131</a><td> this.type = opt_type || &#39;&#39;;<tr><td><a name="l132" href="#l132">132</a><td>};<tr><td><a name="l133" href="#l133">133</a><td><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> * @return {{level: string, message: string, timestamp: number,<tr><td><a name="l137" href="#l137">137</a><td> * type: string}} The JSON representation of this entry.<tr><td><a name="l138" href="#l138">138</a><td> */<tr><td><a name="l139" href="#l139">139</a><td>webdriver.logging.Entry.prototype.toJSON = function() {<tr><td><a name="l140" href="#l140">140</a><td> return {<tr><td><a name="l141" href="#l141">141</a><td> &#39;level&#39;: this.level.name,<tr><td><a name="l142" href="#l142">142</a><td> &#39;message&#39;: this.message,<tr><td><a name="l143" href="#l143">143</a><td> &#39;timestamp&#39;: this.timestamp,<tr><td><a name="l144" href="#l144">144</a><td> &#39;type&#39;: this.type<tr><td><a name="l145" href="#l145">145</a><td> };<tr><td><a name="l146" href="#l146">146</a><td>};<tr><td><a name="l147" href="#l147">147</a><td><tr><td><a name="l148" href="#l148">148</a><td><tr><td><a name="l149" href="#l149">149</a><td>/**<tr><td><a name="l150" href="#l150">150</a><td> * Converts a {@link goog.debug.LogRecord} into a<tr><td><a name="l151" href="#l151">151</a><td> * {@link webdriver.logging.Entry}.<tr><td><a name="l152" href="#l152">152</a><td> * @param {!goog.debug.LogRecord} logRecord The record to convert.<tr><td><a name="l153" href="#l153">153</a><td> * @param {string=} opt_type The log type.<tr><td><a name="l154" href="#l154">154</a><td> * @return {!webdriver.logging.Entry} The converted entry.<tr><td><a name="l155" href="#l155">155</a><td> */<tr><td><a name="l156" href="#l156">156</a><td>webdriver.logging.Entry.fromClosureLogRecord = function(logRecord, opt_type) {<tr><td><a name="l157" href="#l157">157</a><td> var closureLevel = logRecord.getLevel();<tr><td><a name="l158" href="#l158">158</a><td> var level = webdriver.logging.Level.SEVERE;<tr><td><a name="l159" href="#l159">159</a><td><tr><td><a name="l160" href="#l160">160</a><td> if (closureLevel.value &lt;= webdriver.logging.Level.DEBUG.value) {<tr><td><a name="l161" href="#l161">161</a><td> level = webdriver.logging.Level.DEBUG;<tr><td><a name="l162" href="#l162">162</a><td> } else if (closureLevel.value &lt;= webdriver.logging.Level.INFO.value) {<tr><td><a name="l163" href="#l163">163</a><td> level = webdriver.logging.Level.INFO;<tr><td><a name="l164" href="#l164">164</a><td> } else if (closureLevel.value &lt;= webdriver.logging.Level.WARNING.value) {<tr><td><a name="l165" href="#l165">165</a><td> level = webdriver.logging.Level.WARNING;<tr><td><a name="l166" href="#l166">166</a><td> }<tr><td><a name="l167" href="#l167">167</a><td><tr><td><a name="l168" href="#l168">168</a><td> return new webdriver.logging.Entry(<tr><td><a name="l169" href="#l169">169</a><td> level,<tr><td><a name="l170" href="#l170">170</a><td> &#39;[&#39; + logRecord.getLoggerName() + &#39;] &#39; + logRecord.getMessage(),<tr><td><a name="l171" href="#l171">171</a><td> logRecord.getMillis(),<tr><td><a name="l172" href="#l172">172</a><td> opt_type);<tr><td><a name="l173" href="#l173">173</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>logging.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/webdriver/logging.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2013 Selenium comitters<tr><td><a name="l2" href="#l2">2</a><td>// Copyright 2013 Software Freedom Conservancy<tr><td><a name="l3" href="#l3">3</a><td>//<tr><td><a name="l4" href="#l4">4</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l5" href="#l5">5</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l6" href="#l6">6</a><td>// You may obtain a copy of the License at<tr><td><a name="l7" href="#l7">7</a><td>//<tr><td><a name="l8" href="#l8">8</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l9" href="#l9">9</a><td>//<tr><td><a name="l10" href="#l10">10</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l11" href="#l11">11</a><td>// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<tr><td><a name="l12" href="#l12">12</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l13" href="#l13">13</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l14" href="#l14">14</a><td>// limitations under the License.<tr><td><a name="l15" href="#l15">15</a><td><tr><td><a name="l16" href="#l16">16</a><td>goog.provide(&#39;webdriver.logging&#39;);<tr><td><a name="l17" href="#l17">17</a><td>goog.provide(&#39;webdriver.logging.Preferences&#39;);<tr><td><a name="l18" href="#l18">18</a><td><tr><td><a name="l19" href="#l19">19</a><td>goog.require(&#39;goog.object&#39;);<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>/**<tr><td><a name="l23" href="#l23">23</a><td> * Logging levels.<tr><td><a name="l24" href="#l24">24</a><td> * @enum {{value: number, name: string}}<tr><td><a name="l25" href="#l25">25</a><td> */<tr><td><a name="l26" href="#l26">26</a><td>webdriver.logging.Level = {<tr><td><a name="l27" href="#l27">27</a><td> ALL: {value: Number.MIN_VALUE, name: &#39;ALL&#39;},<tr><td><a name="l28" href="#l28">28</a><td> DEBUG: {value: 700, name: &#39;DEBUG&#39;},<tr><td><a name="l29" href="#l29">29</a><td> INFO: {value: 800, name: &#39;INFO&#39;},<tr><td><a name="l30" href="#l30">30</a><td> WARNING: {value: 900, name: &#39;WARNING&#39;},<tr><td><a name="l31" href="#l31">31</a><td> SEVERE: {value: 1000, name: &#39;SEVERE&#39;},<tr><td><a name="l32" href="#l32">32</a><td> OFF: {value: Number.MAX_VALUE, name: &#39;OFF&#39;}<tr><td><a name="l33" href="#l33">33</a><td>};<tr><td><a name="l34" href="#l34">34</a><td><tr><td><a name="l35" href="#l35">35</a><td><tr><td><a name="l36" href="#l36">36</a><td>/**<tr><td><a name="l37" href="#l37">37</a><td> * Converts a level name or value to a {@link webdriver.logging.Level} value.<tr><td><a name="l38" href="#l38">38</a><td> * If the name/value is not recognized, {@link webdriver.logging.Level.ALL}<tr><td><a name="l39" href="#l39">39</a><td> * will be returned.<tr><td><a name="l40" href="#l40">40</a><td> * @param {(number|string)} nameOrValue The log level name, or value, to<tr><td><a name="l41" href="#l41">41</a><td> * convert .<tr><td><a name="l42" href="#l42">42</a><td> * @return {!webdriver.logging.Level} The converted level.<tr><td><a name="l43" href="#l43">43</a><td> */<tr><td><a name="l44" href="#l44">44</a><td>webdriver.logging.getLevel = function(nameOrValue) {<tr><td><a name="l45" href="#l45">45</a><td> var predicate = goog.isString(nameOrValue) ?<tr><td><a name="l46" href="#l46">46</a><td> function(val) { return val.name === nameOrValue; } :<tr><td><a name="l47" href="#l47">47</a><td> function(val) { return val.value === nameOrValue; };<tr><td><a name="l48" href="#l48">48</a><td><tr><td><a name="l49" href="#l49">49</a><td> return goog.object.findValue(webdriver.logging.Level, predicate) ||<tr><td><a name="l50" href="#l50">50</a><td> webdriver.logging.Level.ALL;<tr><td><a name="l51" href="#l51">51</a><td>};<tr><td><a name="l52" href="#l52">52</a><td><tr><td><a name="l53" href="#l53">53</a><td><tr><td><a name="l54" href="#l54">54</a><td>/**<tr><td><a name="l55" href="#l55">55</a><td> * Common log types.<tr><td><a name="l56" href="#l56">56</a><td> * @enum {string}<tr><td><a name="l57" href="#l57">57</a><td> */<tr><td><a name="l58" href="#l58">58</a><td>webdriver.logging.Type = {<tr><td><a name="l59" href="#l59">59</a><td> /** Logs originating from the browser. */<tr><td><a name="l60" href="#l60">60</a><td> BROWSER: &#39;browser&#39;,<tr><td><a name="l61" href="#l61">61</a><td> /** Logs from a WebDriver client. */<tr><td><a name="l62" href="#l62">62</a><td> CLIENT: &#39;client&#39;,<tr><td><a name="l63" href="#l63">63</a><td> /** Logs from a WebDriver implementation. */<tr><td><a name="l64" href="#l64">64</a><td> DRIVER: &#39;driver&#39;,<tr><td><a name="l65" href="#l65">65</a><td> /** Logs related to performance. */<tr><td><a name="l66" href="#l66">66</a><td> PERFORMANCE: &#39;performance&#39;,<tr><td><a name="l67" href="#l67">67</a><td> /** Logs from the remote server. */<tr><td><a name="l68" href="#l68">68</a><td> SERVER: &#39;server&#39;<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><tr><td><a name="l72" href="#l72">72</a><td>/**<tr><td><a name="l73" href="#l73">73</a><td> * Describes the log preferences for a WebDriver session.<tr><td><a name="l74" href="#l74">74</a><td> * @constructor<tr><td><a name="l75" href="#l75">75</a><td> */<tr><td><a name="l76" href="#l76">76</a><td>webdriver.logging.Preferences = function() {<tr><td><a name="l77" href="#l77">77</a><td> /** @private {!Object.&lt;string, webdriver.logging.Level&gt;} */<tr><td><a name="l78" href="#l78">78</a><td> this.prefs_ = {};<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> * Sets the desired logging level for a particular log type.<tr><td><a name="l84" href="#l84">84</a><td> * @param {(string|webdriver.logging.Type)} type The log type.<tr><td><a name="l85" href="#l85">85</a><td> * @param {!webdriver.logging.Level} level The desired log level.<tr><td><a name="l86" href="#l86">86</a><td> */<tr><td><a name="l87" href="#l87">87</a><td>webdriver.logging.Preferences.prototype.setLevel = function(type, level) {<tr><td><a name="l88" href="#l88">88</a><td> this.prefs_[type] = level;<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> * Converts this instance to its JSON representation.<tr><td><a name="l94" href="#l94">94</a><td> * @return {!Object.&lt;string, string&gt;} The JSON representation of this set of<tr><td><a name="l95" href="#l95">95</a><td> * preferences.<tr><td><a name="l96" href="#l96">96</a><td> */<tr><td><a name="l97" href="#l97">97</a><td>webdriver.logging.Preferences.prototype.toJSON = function() {<tr><td><a name="l98" href="#l98">98</a><td> var obj = {};<tr><td><a name="l99" href="#l99">99</a><td> for (var type in this.prefs_) {<tr><td><a name="l100" href="#l100">100</a><td> if (this.prefs_.hasOwnProperty(type)) {<tr><td><a name="l101" href="#l101">101</a><td> obj[type] = this.prefs_[type].name;<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> return obj;<tr><td><a name="l105" href="#l105">105</a><td>};<tr><td><a name="l106" href="#l106">106</a><td><tr><td><a name="l107" href="#l107">107</a><td><tr><td><a name="l108" href="#l108">108</a><td>/**<tr><td><a name="l109" href="#l109">109</a><td> * A single log entry.<tr><td><a name="l110" href="#l110">110</a><td> * @param {(!webdriver.logging.Level|string)} level The entry level.<tr><td><a name="l111" href="#l111">111</a><td> * @param {string} message The log message.<tr><td><a name="l112" href="#l112">112</a><td> * @param {number=} opt_timestamp The time this entry was generated, in<tr><td><a name="l113" href="#l113">113</a><td> * milliseconds since 0:00:00, January 1, 1970 UTC. If omitted, the<tr><td><a name="l114" href="#l114">114</a><td> * current time will be used.<tr><td><a name="l115" href="#l115">115</a><td> * @param {string=} opt_type The log type, if known.<tr><td><a name="l116" href="#l116">116</a><td> * @constructor<tr><td><a name="l117" href="#l117">117</a><td> */<tr><td><a name="l118" href="#l118">118</a><td>webdriver.logging.Entry = function(level, message, opt_timestamp, opt_type) {<tr><td><a name="l119" href="#l119">119</a><td><tr><td><a name="l120" href="#l120">120</a><td> /** @type {!webdriver.logging.Level} */<tr><td><a name="l121" href="#l121">121</a><td> this.level =<tr><td><a name="l122" href="#l122">122</a><td> goog.isString(level) ? webdriver.logging.getLevel(level) : level;<tr><td><a name="l123" href="#l123">123</a><td><tr><td><a name="l124" href="#l124">124</a><td> /** @type {string} */<tr><td><a name="l125" href="#l125">125</a><td> this.message = message;<tr><td><a name="l126" href="#l126">126</a><td><tr><td><a name="l127" href="#l127">127</a><td> /** @type {number} */<tr><td><a name="l128" href="#l128">128</a><td> this.timestamp = goog.isNumber(opt_timestamp) ? opt_timestamp : goog.now();<tr><td><a name="l129" href="#l129">129</a><td><tr><td><a name="l130" href="#l130">130</a><td> /** @type {string} */<tr><td><a name="l131" href="#l131">131</a><td> this.type = opt_type || &#39;&#39;;<tr><td><a name="l132" href="#l132">132</a><td>};<tr><td><a name="l133" href="#l133">133</a><td><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> * @return {{level: string, message: string, timestamp: number,<tr><td><a name="l137" href="#l137">137</a><td> * type: string}} The JSON representation of this entry.<tr><td><a name="l138" href="#l138">138</a><td> */<tr><td><a name="l139" href="#l139">139</a><td>webdriver.logging.Entry.prototype.toJSON = function() {<tr><td><a name="l140" href="#l140">140</a><td> return {<tr><td><a name="l141" href="#l141">141</a><td> &#39;level&#39;: this.level.name,<tr><td><a name="l142" href="#l142">142</a><td> &#39;message&#39;: this.message,<tr><td><a name="l143" href="#l143">143</a><td> &#39;timestamp&#39;: this.timestamp,<tr><td><a name="l144" href="#l144">144</a><td> &#39;type&#39;: this.type<tr><td><a name="l145" href="#l145">145</a><td> };<tr><td><a name="l146" href="#l146">146</a><td>};<tr><td><a name="l147" href="#l147">147</a><td><tr><td><a name="l148" href="#l148">148</a><td><tr><td><a name="l149" href="#l149">149</a><td>/**<tr><td><a name="l150" href="#l150">150</a><td> * Converts a {@link goog.debug.LogRecord} into a<tr><td><a name="l151" href="#l151">151</a><td> * {@link webdriver.logging.Entry}.<tr><td><a name="l152" href="#l152">152</a><td> * @param {!goog.debug.LogRecord} logRecord The record to convert.<tr><td><a name="l153" href="#l153">153</a><td> * @param {string=} opt_type The log type.<tr><td><a name="l154" href="#l154">154</a><td> * @return {!webdriver.logging.Entry} The converted entry.<tr><td><a name="l155" href="#l155">155</a><td> */<tr><td><a name="l156" href="#l156">156</a><td>webdriver.logging.Entry.fromClosureLogRecord = function(logRecord, opt_type) {<tr><td><a name="l157" href="#l157">157</a><td> var closureLevel = logRecord.getLevel();<tr><td><a name="l158" href="#l158">158</a><td> var level = webdriver.logging.Level.SEVERE;<tr><td><a name="l159" href="#l159">159</a><td><tr><td><a name="l160" href="#l160">160</a><td> if (closureLevel.value &lt;= webdriver.logging.Level.DEBUG.value) {<tr><td><a name="l161" href="#l161">161</a><td> level = webdriver.logging.Level.DEBUG;<tr><td><a name="l162" href="#l162">162</a><td> } else if (closureLevel.value &lt;= webdriver.logging.Level.INFO.value) {<tr><td><a name="l163" href="#l163">163</a><td> level = webdriver.logging.Level.INFO;<tr><td><a name="l164" href="#l164">164</a><td> } else if (closureLevel.value &lt;= webdriver.logging.Level.WARNING.value) {<tr><td><a name="l165" href="#l165">165</a><td> level = webdriver.logging.Level.WARNING;<tr><td><a name="l166" href="#l166">166</a><td> }<tr><td><a name="l167" href="#l167">167</a><td><tr><td><a name="l168" href="#l168">168</a><td> return new webdriver.logging.Entry(<tr><td><a name="l169" href="#l169">169</a><td> level,<tr><td><a name="l170" href="#l170">170</a><td> &#39;[&#39; + logRecord.getLoggerName() + &#39;] &#39; + logRecord.getMessage(),<tr><td><a name="l171" href="#l171">171</a><td> logRecord.getMillis(),<tr><td><a name="l172" href="#l172">172</a><td> opt_type);<tr><td><a name="l173" href="#l173">173</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/webdriver/process.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>process.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/webdriver/process.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2011 Software Freedom Conservancy. 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 Provides access to the current process&#39; environment variables.<tr><td><a name="l17" href="#l17">17</a><td> * When running in node, this is simply a wrapper for {@code process.env}.<tr><td><a name="l18" href="#l18">18</a><td> * When running in a browser, environment variables are loaded by parsing the<tr><td><a name="l19" href="#l19">19</a><td> * current URL&#39;s query string. Variables that have more than one variable will<tr><td><a name="l20" href="#l20">20</a><td> * be initialized to the JSON representation of the array of all values,<tr><td><a name="l21" href="#l21">21</a><td> * otherwise the variable will be initialized to a sole string value. If a<tr><td><a name="l22" href="#l22">22</a><td> * variable does not have any values, but is nonetheless present in the query<tr><td><a name="l23" href="#l23">23</a><td> * string, it will be initialized to an empty string.<tr><td><a name="l24" href="#l24">24</a><td> * After the initial parsing, environment variables must be queried and set<tr><td><a name="l25" href="#l25">25</a><td> * through the API defined in this file.<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>goog.provide(&#39;webdriver.process&#39;);<tr><td><a name="l29" href="#l29">29</a><td><tr><td><a name="l30" href="#l30">30</a><td>goog.require(&#39;goog.Uri&#39;);<tr><td><a name="l31" href="#l31">31</a><td>goog.require(&#39;goog.array&#39;);<tr><td><a name="l32" href="#l32">32</a><td>goog.require(&#39;goog.json&#39;);<tr><td><a name="l33" href="#l33">33</a><td><tr><td><a name="l34" href="#l34">34</a><td><tr><td><a name="l35" href="#l35">35</a><td>/**<tr><td><a name="l36" href="#l36">36</a><td> * @return {boolean} Whether the current process is Node&#39;s native process<tr><td><a name="l37" href="#l37">37</a><td> * object.<tr><td><a name="l38" href="#l38">38</a><td> */<tr><td><a name="l39" href="#l39">39</a><td>webdriver.process.isNative = function() {<tr><td><a name="l40" href="#l40">40</a><td> return webdriver.process.IS_NATIVE_PROCESS_;<tr><td><a name="l41" href="#l41">41</a><td>};<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> * Queries for a named environment variable.<tr><td><a name="l46" href="#l46">46</a><td> * @param {string} name The name of the environment variable to look up.<tr><td><a name="l47" href="#l47">47</a><td> * @param {string=} opt_default The default value if the named variable is not<tr><td><a name="l48" href="#l48">48</a><td> * defined.<tr><td><a name="l49" href="#l49">49</a><td> * @return {string} The queried environment variable.<tr><td><a name="l50" href="#l50">50</a><td> */<tr><td><a name="l51" href="#l51">51</a><td>webdriver.process.getEnv = function(name, opt_default) {<tr><td><a name="l52" href="#l52">52</a><td> var value = webdriver.process.PROCESS_.env[name];<tr><td><a name="l53" href="#l53">53</a><td> return goog.isDefAndNotNull(value) ? value : opt_default;<tr><td><a name="l54" href="#l54">54</a><td>};<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> * Sets an environment value. If the new value is either null or undefined, the<tr><td><a name="l59" href="#l59">59</a><td> * environment variable will be cleared.<tr><td><a name="l60" href="#l60">60</a><td> * @param {string} name The value to set.<tr><td><a name="l61" href="#l61">61</a><td> * @param {*} value The new value; will be coerced to a string.<tr><td><a name="l62" href="#l62">62</a><td> */<tr><td><a name="l63" href="#l63">63</a><td>webdriver.process.setEnv = function(name, value) {<tr><td><a name="l64" href="#l64">64</a><td> webdriver.process.PROCESS_.env[name] =<tr><td><a name="l65" href="#l65">65</a><td> goog.isDefAndNotNull(value) ? value + &#39;&#39; : null;<tr><td><a name="l66" href="#l66">66</a><td>};<tr><td><a name="l67" href="#l67">67</a><td><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> * Whether the current environment is using Node&#39;s native process object.<tr><td><a name="l71" href="#l71">71</a><td> * @private {boolean}<tr><td><a name="l72" href="#l72">72</a><td> * @const<tr><td><a name="l73" href="#l73">73</a><td> */<tr><td><a name="l74" href="#l74">74</a><td>webdriver.process.IS_NATIVE_PROCESS_ = typeof process !== &#39;undefined&#39;;<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>/**<tr><td><a name="l78" href="#l78">78</a><td> * Initializes a process object for use in a browser window.<tr><td><a name="l79" href="#l79">79</a><td> * @param {!Window=} opt_window The window object to initialize the process<tr><td><a name="l80" href="#l80">80</a><td> * from; if not specified, will default to the current window. Should only<tr><td><a name="l81" href="#l81">81</a><td> * be set for unit testing.<tr><td><a name="l82" href="#l82">82</a><td> * @return {!Object} The new process object.<tr><td><a name="l83" href="#l83">83</a><td> * @private<tr><td><a name="l84" href="#l84">84</a><td> */<tr><td><a name="l85" href="#l85">85</a><td>webdriver.process.initBrowserProcess_ = function(opt_window) {<tr><td><a name="l86" href="#l86">86</a><td> var process = {&#39;env&#39;: {}};<tr><td><a name="l87" href="#l87">87</a><td><tr><td><a name="l88" href="#l88">88</a><td> var win = opt_window;<tr><td><a name="l89" href="#l89">89</a><td> if (!win &amp;&amp; typeof window != &#39;undefined&#39;) {<tr><td><a name="l90" href="#l90">90</a><td> win = window;<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> // Initialize the global error handler.<tr><td><a name="l94" href="#l94">94</a><td> if (win) {<tr><td><a name="l95" href="#l95">95</a><td> // Initialize the environment variable map by parsing the current URL query<tr><td><a name="l96" href="#l96">96</a><td> // string.<tr><td><a name="l97" href="#l97">97</a><td> if (win.location) {<tr><td><a name="l98" href="#l98">98</a><td> var data = new goog.Uri(win.location).getQueryData();<tr><td><a name="l99" href="#l99">99</a><td> goog.array.forEach(data.getKeys(), function(key) {<tr><td><a name="l100" href="#l100">100</a><td> var values = data.getValues(key);<tr><td><a name="l101" href="#l101">101</a><td> process.env[key] = values.length == 0 ? &#39;&#39; :<tr><td><a name="l102" href="#l102">102</a><td> values.length == 1 ? values[0] :<tr><td><a name="l103" href="#l103">103</a><td> goog.json.serialize(values);<tr><td><a name="l104" href="#l104">104</a><td> });<tr><td><a name="l105" href="#l105">105</a><td> }<tr><td><a name="l106" href="#l106">106</a><td> }<tr><td><a name="l107" href="#l107">107</a><td><tr><td><a name="l108" href="#l108">108</a><td> return process;<tr><td><a name="l109" href="#l109">109</a><td>};<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> * The global process object to use. Will either be Node&#39;s global<tr><td><a name="l114" href="#l114">114</a><td> * {@code process} object, or an approximation of it for use in a browser<tr><td><a name="l115" href="#l115">115</a><td> * environment.<tr><td><a name="l116" href="#l116">116</a><td> * @private {!Object}<tr><td><a name="l117" href="#l117">117</a><td> * @const<tr><td><a name="l118" href="#l118">118</a><td> */<tr><td><a name="l119" href="#l119">119</a><td>webdriver.process.PROCESS_ = webdriver.process.IS_NATIVE_PROCESS_ ? process :<tr><td><a name="l120" href="#l120">120</a><td> webdriver.process.initBrowserProcess_();</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>process.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/webdriver/process.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2011 Software Freedom Conservancy. 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 Provides access to the current process&#39; environment variables.<tr><td><a name="l17" href="#l17">17</a><td> * When running in node, this is simply a wrapper for {@code process.env}.<tr><td><a name="l18" href="#l18">18</a><td> * When running in a browser, environment variables are loaded by parsing the<tr><td><a name="l19" href="#l19">19</a><td> * current URL&#39;s query string. Variables that have more than one variable will<tr><td><a name="l20" href="#l20">20</a><td> * be initialized to the JSON representation of the array of all values,<tr><td><a name="l21" href="#l21">21</a><td> * otherwise the variable will be initialized to a sole string value. If a<tr><td><a name="l22" href="#l22">22</a><td> * variable does not have any values, but is nonetheless present in the query<tr><td><a name="l23" href="#l23">23</a><td> * string, it will be initialized to an empty string.<tr><td><a name="l24" href="#l24">24</a><td> * After the initial parsing, environment variables must be queried and set<tr><td><a name="l25" href="#l25">25</a><td> * through the API defined in this file.<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>goog.provide(&#39;webdriver.process&#39;);<tr><td><a name="l29" href="#l29">29</a><td><tr><td><a name="l30" href="#l30">30</a><td>goog.require(&#39;goog.Uri&#39;);<tr><td><a name="l31" href="#l31">31</a><td>goog.require(&#39;goog.array&#39;);<tr><td><a name="l32" href="#l32">32</a><td>goog.require(&#39;goog.json&#39;);<tr><td><a name="l33" href="#l33">33</a><td><tr><td><a name="l34" href="#l34">34</a><td><tr><td><a name="l35" href="#l35">35</a><td>/**<tr><td><a name="l36" href="#l36">36</a><td> * @return {boolean} Whether the current process is Node&#39;s native process<tr><td><a name="l37" href="#l37">37</a><td> * object.<tr><td><a name="l38" href="#l38">38</a><td> */<tr><td><a name="l39" href="#l39">39</a><td>webdriver.process.isNative = function() {<tr><td><a name="l40" href="#l40">40</a><td> return webdriver.process.IS_NATIVE_PROCESS_;<tr><td><a name="l41" href="#l41">41</a><td>};<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> * Queries for a named environment variable.<tr><td><a name="l46" href="#l46">46</a><td> * @param {string} name The name of the environment variable to look up.<tr><td><a name="l47" href="#l47">47</a><td> * @param {string=} opt_default The default value if the named variable is not<tr><td><a name="l48" href="#l48">48</a><td> * defined.<tr><td><a name="l49" href="#l49">49</a><td> * @return {string} The queried environment variable.<tr><td><a name="l50" href="#l50">50</a><td> */<tr><td><a name="l51" href="#l51">51</a><td>webdriver.process.getEnv = function(name, opt_default) {<tr><td><a name="l52" href="#l52">52</a><td> var value = webdriver.process.PROCESS_.env[name];<tr><td><a name="l53" href="#l53">53</a><td> return goog.isDefAndNotNull(value) ? value : opt_default;<tr><td><a name="l54" href="#l54">54</a><td>};<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> * Sets an environment value. If the new value is either null or undefined, the<tr><td><a name="l59" href="#l59">59</a><td> * environment variable will be cleared.<tr><td><a name="l60" href="#l60">60</a><td> * @param {string} name The value to set.<tr><td><a name="l61" href="#l61">61</a><td> * @param {*} value The new value; will be coerced to a string.<tr><td><a name="l62" href="#l62">62</a><td> */<tr><td><a name="l63" href="#l63">63</a><td>webdriver.process.setEnv = function(name, value) {<tr><td><a name="l64" href="#l64">64</a><td> webdriver.process.PROCESS_.env[name] =<tr><td><a name="l65" href="#l65">65</a><td> goog.isDefAndNotNull(value) ? value + &#39;&#39; : null;<tr><td><a name="l66" href="#l66">66</a><td>};<tr><td><a name="l67" href="#l67">67</a><td><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> * Whether the current environment is using Node&#39;s native process object.<tr><td><a name="l71" href="#l71">71</a><td> * @private {boolean}<tr><td><a name="l72" href="#l72">72</a><td> * @const<tr><td><a name="l73" href="#l73">73</a><td> */<tr><td><a name="l74" href="#l74">74</a><td>webdriver.process.IS_NATIVE_PROCESS_ = typeof process !== &#39;undefined&#39;;<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>/**<tr><td><a name="l78" href="#l78">78</a><td> * Initializes a process object for use in a browser window.<tr><td><a name="l79" href="#l79">79</a><td> * @param {!Window=} opt_window The window object to initialize the process<tr><td><a name="l80" href="#l80">80</a><td> * from; if not specified, will default to the current window. Should only<tr><td><a name="l81" href="#l81">81</a><td> * be set for unit testing.<tr><td><a name="l82" href="#l82">82</a><td> * @return {!Object} The new process object.<tr><td><a name="l83" href="#l83">83</a><td> * @private<tr><td><a name="l84" href="#l84">84</a><td> */<tr><td><a name="l85" href="#l85">85</a><td>webdriver.process.initBrowserProcess_ = function(opt_window) {<tr><td><a name="l86" href="#l86">86</a><td> var process = {&#39;env&#39;: {}};<tr><td><a name="l87" href="#l87">87</a><td><tr><td><a name="l88" href="#l88">88</a><td> var win = opt_window;<tr><td><a name="l89" href="#l89">89</a><td> if (!win &amp;&amp; typeof window != &#39;undefined&#39;) {<tr><td><a name="l90" href="#l90">90</a><td> win = window;<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> // Initialize the global error handler.<tr><td><a name="l94" href="#l94">94</a><td> if (win) {<tr><td><a name="l95" href="#l95">95</a><td> // Initialize the environment variable map by parsing the current URL query<tr><td><a name="l96" href="#l96">96</a><td> // string.<tr><td><a name="l97" href="#l97">97</a><td> if (win.location) {<tr><td><a name="l98" href="#l98">98</a><td> var data = new goog.Uri(win.location).getQueryData();<tr><td><a name="l99" href="#l99">99</a><td> goog.array.forEach(data.getKeys(), function(key) {<tr><td><a name="l100" href="#l100">100</a><td> var values = data.getValues(key);<tr><td><a name="l101" href="#l101">101</a><td> process.env[key] = values.length == 0 ? &#39;&#39; :<tr><td><a name="l102" href="#l102">102</a><td> values.length == 1 ? values[0] :<tr><td><a name="l103" href="#l103">103</a><td> goog.json.serialize(values);<tr><td><a name="l104" href="#l104">104</a><td> });<tr><td><a name="l105" href="#l105">105</a><td> }<tr><td><a name="l106" href="#l106">106</a><td> }<tr><td><a name="l107" href="#l107">107</a><td><tr><td><a name="l108" href="#l108">108</a><td> return process;<tr><td><a name="l109" href="#l109">109</a><td>};<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> * The global process object to use. Will either be Node&#39;s global<tr><td><a name="l114" href="#l114">114</a><td> * {@code process} object, or an approximation of it for use in a browser<tr><td><a name="l115" href="#l115">115</a><td> * environment.<tr><td><a name="l116" href="#l116">116</a><td> * @private {!Object}<tr><td><a name="l117" href="#l117">117</a><td> * @const<tr><td><a name="l118" href="#l118">118</a><td> */<tr><td><a name="l119" href="#l119">119</a><td>webdriver.process.PROCESS_ = webdriver.process.IS_NATIVE_PROCESS_ ? process :<tr><td><a name="l120" href="#l120">120</a><td> webdriver.process.initBrowserProcess_();</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>