selenium-webdriver 2.43.5 → 2.44.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (219) hide show
  1. package/CHANGES.md +20 -0
  2. package/README.md +8 -13
  3. package/builder.js +4 -3
  4. package/docs/class_webdriver_Alert.html +6 -6
  5. package/docs/class_webdriver_AlertPromise.html +6 -6
  6. package/docs/class_webdriver_UnhandledAlertError.html +4 -4
  7. package/docs/class_webdriver_WebDriver.html +39 -37
  8. package/docs/class_webdriver_WebDriver_Logs.html +3 -3
  9. package/docs/class_webdriver_WebDriver_Navigation.html +5 -5
  10. package/docs/class_webdriver_WebDriver_Options.html +9 -9
  11. package/docs/class_webdriver_WebDriver_TargetLocator.html +6 -6
  12. package/docs/class_webdriver_WebDriver_Timeouts.html +4 -4
  13. package/docs/class_webdriver_WebDriver_Window.html +6 -6
  14. package/docs/class_webdriver_WebElement.html +23 -23
  15. package/docs/class_webdriver_WebElementPromise.html +22 -22
  16. package/docs/class_webdriver_promise_CancellationError.html +3 -0
  17. package/docs/class_webdriver_promise_ControlFlow.html +32 -32
  18. package/docs/class_webdriver_promise_Deferred.html +7 -8
  19. package/docs/class_webdriver_promise_Frame_.html +14 -30
  20. package/docs/class_webdriver_promise_Promise.html +2 -2
  21. package/docs/class_webdriver_promise_Task_.html +12 -12
  22. package/docs/class_webdriver_until_Condition.html +3 -0
  23. package/docs/enum_webdriver_Key.html +1 -1
  24. package/docs/enum_webdriver_promise_ControlFlow_EventType.html +1 -1
  25. package/docs/enum_webdriver_promise_Deferred_State_.html +1 -1
  26. package/docs/index.html +8 -13
  27. package/docs/interface_webdriver_promise_Thenable.html +8 -10
  28. package/docs/license.html +1 -1
  29. package/docs/module_selenium-webdriver.html +2 -2
  30. package/docs/module_selenium-webdriver__base.html +1 -1
  31. package/docs/module_selenium-webdriver__base_class_Context.html +1 -1
  32. package/docs/module_selenium-webdriver_builder.html +1 -1
  33. package/docs/module_selenium-webdriver_builder_class_Builder.html +1 -1
  34. package/docs/module_selenium-webdriver_chrome.html +1 -1
  35. package/docs/module_selenium-webdriver_chrome_class_Driver.html +2 -2
  36. package/docs/module_selenium-webdriver_chrome_class_Options.html +2 -2
  37. package/docs/module_selenium-webdriver_chrome_class_ServiceBuilder.html +1 -1
  38. package/docs/module_selenium-webdriver_error.html +1 -1
  39. package/docs/module_selenium-webdriver_executors.html +1 -1
  40. package/docs/module_selenium-webdriver_firefox.html +1 -1
  41. package/docs/module_selenium-webdriver_firefox_binary.html +1 -1
  42. package/docs/module_selenium-webdriver_firefox_binary_class_Binary.html +1 -1
  43. package/docs/module_selenium-webdriver_firefox_class_Driver.html +2 -2
  44. package/docs/module_selenium-webdriver_firefox_class_Options.html +1 -1
  45. package/docs/module_selenium-webdriver_firefox_extension.html +1 -1
  46. package/docs/module_selenium-webdriver_firefox_profile.html +1 -1
  47. package/docs/module_selenium-webdriver_firefox_profile_class_Profile.html +1 -1
  48. package/docs/module_selenium-webdriver_http.html +1 -1
  49. package/docs/module_selenium-webdriver_http_class_HttpClient.html +1 -1
  50. package/docs/module_selenium-webdriver_http_util.html +1 -1
  51. package/docs/module_selenium-webdriver_io.html +1 -1
  52. package/docs/module_selenium-webdriver_io_exec.html +1 -1
  53. package/docs/module_selenium-webdriver_net.html +1 -1
  54. package/docs/module_selenium-webdriver_net_portprober.html +1 -1
  55. package/docs/module_selenium-webdriver_phantomjs.html +1 -1
  56. package/docs/module_selenium-webdriver_phantomjs_class_Driver.html +2 -2
  57. package/docs/module_selenium-webdriver_proxy.html +1 -1
  58. package/docs/module_selenium-webdriver_remote.html +1 -1
  59. package/docs/module_selenium-webdriver_remote_class_DriverService.html +2 -2
  60. package/docs/module_selenium-webdriver_remote_class_SeleniumServer.html +2 -2
  61. package/docs/module_selenium-webdriver_testing.html +16 -29
  62. package/docs/module_selenium-webdriver_testing_assert.html +1 -1
  63. package/docs/namespace_webdriver_promise.html +18 -20
  64. package/docs/namespace_webdriver_stacktrace.html +15 -15
  65. package/docs/namespace_webdriver_until.html +32 -0
  66. package/docs/source/_base.js.src.html +1 -1
  67. package/docs/source/builder.js.src.html +1 -1
  68. package/docs/source/chrome.js.src.html +1 -1
  69. package/docs/source/error.js.src.html +1 -1
  70. package/docs/source/executors.js.src.html +1 -1
  71. package/docs/source/firefox/binary.js.src.html +1 -1
  72. package/docs/source/firefox/extension.js.src.html +1 -1
  73. package/docs/source/firefox/index.js.src.html +1 -1
  74. package/docs/source/firefox/profile.js.src.html +1 -1
  75. package/docs/source/http/index.js.src.html +1 -1
  76. package/docs/source/http/util.js.src.html +1 -1
  77. package/docs/source/index.js.src.html +1 -1
  78. package/docs/source/io/exec.js.src.html +1 -1
  79. package/docs/source/io/index.js.src.html +1 -1
  80. package/docs/source/lib/atoms/error.js.src.html +1 -1
  81. package/docs/source/lib/atoms/json.js.src.html +1 -1
  82. package/docs/source/lib/atoms/response.js.src.html +1 -1
  83. package/docs/source/lib/atoms/userAgent.js.src.html +1 -1
  84. package/docs/source/lib/goog/array/array.js.src.html +1 -1
  85. package/docs/source/lib/goog/asserts/asserts.js.src.html +1 -1
  86. package/docs/source/lib/goog/async/nexttick.js.src.html +1 -1
  87. package/docs/source/lib/goog/async/run.js.src.html +1 -1
  88. package/docs/source/lib/goog/base.js.src.html +1 -1
  89. package/docs/source/lib/goog/debug/debug.js.src.html +1 -1
  90. package/docs/source/lib/goog/debug/entrypointregistry.js.src.html +1 -1
  91. package/docs/source/lib/goog/debug/error.js.src.html +1 -1
  92. package/docs/source/lib/goog/debug/logbuffer.js.src.html +1 -1
  93. package/docs/source/lib/goog/debug/logger.js.src.html +1 -1
  94. package/docs/source/lib/goog/debug/logrecord.js.src.html +1 -1
  95. package/docs/source/lib/goog/deps.js.src.html +1 -1
  96. package/docs/source/lib/goog/disposable/disposable.js.src.html +1 -1
  97. package/docs/source/lib/goog/disposable/idisposable.js.src.html +1 -1
  98. package/docs/source/lib/goog/dom/browserfeature.js.src.html +1 -1
  99. package/docs/source/lib/goog/dom/dom.js.src.html +1 -1
  100. package/docs/source/lib/goog/dom/nodetype.js.src.html +1 -1
  101. package/docs/source/lib/goog/dom/tagname.js.src.html +1 -1
  102. package/docs/source/lib/goog/dom/vendor.js.src.html +1 -1
  103. package/docs/source/lib/goog/events/browserevent.js.src.html +1 -1
  104. package/docs/source/lib/goog/events/browserfeature.js.src.html +1 -1
  105. package/docs/source/lib/goog/events/event.js.src.html +1 -1
  106. package/docs/source/lib/goog/events/eventid.js.src.html +1 -1
  107. package/docs/source/lib/goog/events/events.js.src.html +1 -1
  108. package/docs/source/lib/goog/events/eventtarget.js.src.html +1 -1
  109. package/docs/source/lib/goog/events/eventtype.js.src.html +1 -1
  110. package/docs/source/lib/goog/events/keycodes.js.src.html +1 -1
  111. package/docs/source/lib/goog/events/listenable.js.src.html +1 -1
  112. package/docs/source/lib/goog/events/listener.js.src.html +1 -1
  113. package/docs/source/lib/goog/events/listenermap.js.src.html +1 -1
  114. package/docs/source/lib/goog/functions/functions.js.src.html +1 -1
  115. package/docs/source/lib/goog/iter/iter.js.src.html +1 -1
  116. package/docs/source/lib/goog/json/json.js.src.html +1 -1
  117. package/docs/source/lib/goog/labs/testing/assertthat.js.src.html +1 -1
  118. package/docs/source/lib/goog/labs/testing/logicmatcher.js.src.html +1 -1
  119. package/docs/source/lib/goog/labs/testing/matcher.js.src.html +1 -1
  120. package/docs/source/lib/goog/labs/testing/numbermatcher.js.src.html +1 -1
  121. package/docs/source/lib/goog/labs/testing/objectmatcher.js.src.html +1 -1
  122. package/docs/source/lib/goog/labs/testing/stringmatcher.js.src.html +1 -1
  123. package/docs/source/lib/goog/labs/useragent/browser.js.src.html +1 -1
  124. package/docs/source/lib/goog/labs/useragent/engine.js.src.html +1 -1
  125. package/docs/source/lib/goog/labs/useragent/util.js.src.html +1 -1
  126. package/docs/source/lib/goog/math/box.js.src.html +1 -1
  127. package/docs/source/lib/goog/math/coordinate.js.src.html +1 -1
  128. package/docs/source/lib/goog/math/math.js.src.html +1 -1
  129. package/docs/source/lib/goog/math/rect.js.src.html +1 -1
  130. package/docs/source/lib/goog/math/size.js.src.html +1 -1
  131. package/docs/source/lib/goog/net/wrapperxmlhttpfactory.js.src.html +1 -1
  132. package/docs/source/lib/goog/net/xhrlike.js.src.html +1 -1
  133. package/docs/source/lib/goog/net/xmlhttp.js.src.html +1 -1
  134. package/docs/source/lib/goog/net/xmlhttpfactory.js.src.html +1 -1
  135. package/docs/source/lib/goog/object/object.js.src.html +1 -1
  136. package/docs/source/lib/goog/reflect/reflect.js.src.html +1 -1
  137. package/docs/source/lib/goog/string/string.js.src.html +1 -1
  138. package/docs/source/lib/goog/structs/collection.js.src.html +1 -1
  139. package/docs/source/lib/goog/structs/map.js.src.html +1 -1
  140. package/docs/source/lib/goog/structs/set.js.src.html +1 -1
  141. package/docs/source/lib/goog/structs/structs.js.src.html +1 -1
  142. package/docs/source/lib/goog/style/style.js.src.html +1 -1
  143. package/docs/source/lib/goog/testing/asserts.js.src.html +1 -1
  144. package/docs/source/lib/goog/testing/asynctestcase.js.src.html +1 -1
  145. package/docs/source/lib/goog/testing/events/events.js.src.html +1 -1
  146. package/docs/source/lib/goog/testing/functionmock.js.src.html +1 -1
  147. package/docs/source/lib/goog/testing/jsunit.js.src.html +1 -1
  148. package/docs/source/lib/goog/testing/loosemock.js.src.html +1 -1
  149. package/docs/source/lib/goog/testing/mock.js.src.html +1 -1
  150. package/docs/source/lib/goog/testing/mockclock.js.src.html +1 -1
  151. package/docs/source/lib/goog/testing/mockcontrol.js.src.html +1 -1
  152. package/docs/source/lib/goog/testing/mockinterface.js.src.html +1 -1
  153. package/docs/source/lib/goog/testing/mockmatchers.js.src.html +1 -1
  154. package/docs/source/lib/goog/testing/objectpropertystring.js.src.html +1 -1
  155. package/docs/source/lib/goog/testing/propertyreplacer.js.src.html +1 -1
  156. package/docs/source/lib/goog/testing/recordfunction.js.src.html +1 -1
  157. package/docs/source/lib/goog/testing/stacktrace.js.src.html +1 -1
  158. package/docs/source/lib/goog/testing/strictmock.js.src.html +1 -1
  159. package/docs/source/lib/goog/testing/testcase.js.src.html +1 -1
  160. package/docs/source/lib/goog/testing/testrunner.js.src.html +1 -1
  161. package/docs/source/lib/goog/testing/watchers.js.src.html +1 -1
  162. package/docs/source/lib/goog/uri/uri.js.src.html +1 -1
  163. package/docs/source/lib/goog/uri/utils.js.src.html +1 -1
  164. package/docs/source/lib/goog/useragent/product.js.src.html +1 -1
  165. package/docs/source/lib/goog/useragent/product_isversion.js.src.html +1 -1
  166. package/docs/source/lib/goog/useragent/useragent.js.src.html +1 -1
  167. package/docs/source/lib/webdriver/abstractbuilder.js.src.html +1 -1
  168. package/docs/source/lib/webdriver/actionsequence.js.src.html +1 -1
  169. package/docs/source/lib/webdriver/builder.js.src.html +1 -1
  170. package/docs/source/lib/webdriver/button.js.src.html +1 -1
  171. package/docs/source/lib/webdriver/capabilities.js.src.html +1 -1
  172. package/docs/source/lib/webdriver/command.js.src.html +1 -1
  173. package/docs/source/lib/webdriver/events.js.src.html +1 -1
  174. package/docs/source/lib/webdriver/firefoxdomexecutor.js.src.html +1 -1
  175. package/docs/source/lib/webdriver/http/corsclient.js.src.html +1 -1
  176. package/docs/source/lib/webdriver/http/http.js.src.html +1 -1
  177. package/docs/source/lib/webdriver/http/xhrclient.js.src.html +1 -1
  178. package/docs/source/lib/webdriver/key.js.src.html +1 -1
  179. package/docs/source/lib/webdriver/locators.js.src.html +1 -1
  180. package/docs/source/lib/webdriver/logging.js.src.html +1 -1
  181. package/docs/source/lib/webdriver/process.js.src.html +1 -1
  182. package/docs/source/lib/webdriver/promise.js.src.html +1 -1
  183. package/docs/source/lib/webdriver/session.js.src.html +1 -1
  184. package/docs/source/lib/webdriver/stacktrace.js.src.html +1 -1
  185. package/docs/source/lib/webdriver/testing/asserts.js.src.html +1 -1
  186. package/docs/source/lib/webdriver/testing/testcase.js.src.html +1 -1
  187. package/docs/source/lib/webdriver/until.js.src.html +1 -0
  188. package/docs/source/lib/webdriver/webdriver.js.src.html +1 -1
  189. package/docs/source/net/index.js.src.html +1 -1
  190. package/docs/source/net/portprober.js.src.html +1 -1
  191. package/docs/source/phantomjs.js.src.html +1 -1
  192. package/docs/source/proxy.js.src.html +1 -1
  193. package/docs/source/remote/index.js.src.html +1 -1
  194. package/docs/source/testing/assert.js.src.html +1 -1
  195. package/docs/source/testing/index.js.src.html +1 -1
  196. package/docs/types.js +1 -1
  197. package/example/google_search.js +9 -17
  198. package/example/google_search_generator.js +6 -7
  199. package/example/google_search_test.js +10 -18
  200. package/example/parallel_flows.js +4 -7
  201. package/index.js +6 -0
  202. package/lib/firefox/webdriver.xpi +0 -0
  203. package/lib/goog/deps.js +7 -5
  204. package/lib/test/index.js +0 -8
  205. package/lib/webdriver/promise.js +263 -251
  206. package/lib/webdriver/stacktrace.js +15 -1
  207. package/lib/webdriver/test/promise_flow_test.js +82 -76
  208. package/lib/webdriver/test/promise_test.js +22 -62
  209. package/lib/webdriver/test/stacktrace_test.js +18 -0
  210. package/lib/webdriver/test/until_test.js +388 -0
  211. package/lib/webdriver/test/webdriver_test.js +41 -0
  212. package/lib/webdriver/until.js +408 -0
  213. package/lib/webdriver/webdriver.js +91 -29
  214. package/package.json +2 -2
  215. package/test/element_finding_test.js +6 -6
  216. package/test/http/util_test.js +4 -5
  217. package/test/page_loading_test.js +7 -7
  218. package/test/stale_element_test.js +2 -10
  219. package/testing/index.js +9 -22
package/docs/source/lib/goog/math/size.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>size.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/math/size.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2007 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview A utility class for representing two-dimensional sizes.<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><tr><td><a name="l20" href="#l20">20</a><td>goog.provide(&#39;goog.math.Size&#39;);<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><tr><td><a name="l24" href="#l24">24</a><td>/**<tr><td><a name="l25" href="#l25">25</a><td> * Class for representing sizes consisting of a width and height. Undefined<tr><td><a name="l26" href="#l26">26</a><td> * width and height support is deprecated and results in compiler warning.<tr><td><a name="l27" href="#l27">27</a><td> * @param {number} width Width.<tr><td><a name="l28" href="#l28">28</a><td> * @param {number} height Height.<tr><td><a name="l29" href="#l29">29</a><td> * @constructor<tr><td><a name="l30" href="#l30">30</a><td> */<tr><td><a name="l31" href="#l31">31</a><td>goog.math.Size = function(width, height) {<tr><td><a name="l32" href="#l32">32</a><td> /**<tr><td><a name="l33" href="#l33">33</a><td> * Width<tr><td><a name="l34" href="#l34">34</a><td> * @type {number}<tr><td><a name="l35" href="#l35">35</a><td> */<tr><td><a name="l36" href="#l36">36</a><td> this.width = width;<tr><td><a name="l37" href="#l37">37</a><td><tr><td><a name="l38" href="#l38">38</a><td> /**<tr><td><a name="l39" href="#l39">39</a><td> * Height<tr><td><a name="l40" href="#l40">40</a><td> * @type {number}<tr><td><a name="l41" href="#l41">41</a><td> */<tr><td><a name="l42" href="#l42">42</a><td> this.height = height;<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><tr><td><a name="l46" href="#l46">46</a><td>/**<tr><td><a name="l47" href="#l47">47</a><td> * Compares sizes for equality.<tr><td><a name="l48" href="#l48">48</a><td> * @param {goog.math.Size} a A Size.<tr><td><a name="l49" href="#l49">49</a><td> * @param {goog.math.Size} b A Size.<tr><td><a name="l50" href="#l50">50</a><td> * @return {boolean} True iff the sizes have equal widths and equal<tr><td><a name="l51" href="#l51">51</a><td> * heights, or if both are null.<tr><td><a name="l52" href="#l52">52</a><td> */<tr><td><a name="l53" href="#l53">53</a><td>goog.math.Size.equals = function(a, b) {<tr><td><a name="l54" href="#l54">54</a><td> if (a == b) {<tr><td><a name="l55" href="#l55">55</a><td> return true;<tr><td><a name="l56" href="#l56">56</a><td> }<tr><td><a name="l57" href="#l57">57</a><td> if (!a || !b) {<tr><td><a name="l58" href="#l58">58</a><td> return false;<tr><td><a name="l59" href="#l59">59</a><td> }<tr><td><a name="l60" href="#l60">60</a><td> return a.width == b.width &amp;&amp; a.height == b.height;<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> * @return {!goog.math.Size} A new copy of the Size.<tr><td><a name="l66" href="#l66">66</a><td> */<tr><td><a name="l67" href="#l67">67</a><td>goog.math.Size.prototype.clone = function() {<tr><td><a name="l68" href="#l68">68</a><td> return new goog.math.Size(this.width, this.height);<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>if (goog.DEBUG) {<tr><td><a name="l73" href="#l73">73</a><td> /**<tr><td><a name="l74" href="#l74">74</a><td> * Returns a nice string representing size.<tr><td><a name="l75" href="#l75">75</a><td> * @return {string} In the form (50 x 73).<tr><td><a name="l76" href="#l76">76</a><td> * @override<tr><td><a name="l77" href="#l77">77</a><td> */<tr><td><a name="l78" href="#l78">78</a><td> goog.math.Size.prototype.toString = function() {<tr><td><a name="l79" href="#l79">79</a><td> return &#39;(&#39; + this.width + &#39; x &#39; + this.height + &#39;)&#39;;<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><tr><td><a name="l84" href="#l84">84</a><td>/**<tr><td><a name="l85" href="#l85">85</a><td> * @return {number} The longer of the two dimensions in the size.<tr><td><a name="l86" href="#l86">86</a><td> */<tr><td><a name="l87" href="#l87">87</a><td>goog.math.Size.prototype.getLongest = function() {<tr><td><a name="l88" href="#l88">88</a><td> return Math.max(this.width, this.height);<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> * @return {number} The shorter of the two dimensions in the size.<tr><td><a name="l94" href="#l94">94</a><td> */<tr><td><a name="l95" href="#l95">95</a><td>goog.math.Size.prototype.getShortest = function() {<tr><td><a name="l96" href="#l96">96</a><td> return Math.min(this.width, this.height);<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>/**<tr><td><a name="l101" href="#l101">101</a><td> * @return {number} The area of the size (width * height).<tr><td><a name="l102" href="#l102">102</a><td> */<tr><td><a name="l103" href="#l103">103</a><td>goog.math.Size.prototype.area = function() {<tr><td><a name="l104" href="#l104">104</a><td> return this.width * this.height;<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> * @return {number} The perimeter of the size (width + height) * 2.<tr><td><a name="l110" href="#l110">110</a><td> */<tr><td><a name="l111" href="#l111">111</a><td>goog.math.Size.prototype.perimeter = function() {<tr><td><a name="l112" href="#l112">112</a><td> return (this.width + this.height) * 2;<tr><td><a name="l113" href="#l113">113</a><td>};<tr><td><a name="l114" href="#l114">114</a><td><tr><td><a name="l115" href="#l115">115</a><td><tr><td><a name="l116" href="#l116">116</a><td>/**<tr><td><a name="l117" href="#l117">117</a><td> * @return {number} The ratio of the size&#39;s width to its height.<tr><td><a name="l118" href="#l118">118</a><td> */<tr><td><a name="l119" href="#l119">119</a><td>goog.math.Size.prototype.aspectRatio = function() {<tr><td><a name="l120" href="#l120">120</a><td> return this.width / this.height;<tr><td><a name="l121" href="#l121">121</a><td>};<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> * @return {boolean} True if the size has zero area, false if both dimensions<tr><td><a name="l126" href="#l126">126</a><td> * are non-zero numbers.<tr><td><a name="l127" href="#l127">127</a><td> */<tr><td><a name="l128" href="#l128">128</a><td>goog.math.Size.prototype.isEmpty = function() {<tr><td><a name="l129" href="#l129">129</a><td> return !this.area();<tr><td><a name="l130" href="#l130">130</a><td>};<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> * Clamps the width and height parameters upward to integer values.<tr><td><a name="l135" href="#l135">135</a><td> * @return {!goog.math.Size} This size with ceil&#39;d components.<tr><td><a name="l136" href="#l136">136</a><td> */<tr><td><a name="l137" href="#l137">137</a><td>goog.math.Size.prototype.ceil = function() {<tr><td><a name="l138" href="#l138">138</a><td> this.width = Math.ceil(this.width);<tr><td><a name="l139" href="#l139">139</a><td> this.height = Math.ceil(this.height);<tr><td><a name="l140" href="#l140">140</a><td> return this;<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>/**<tr><td><a name="l145" href="#l145">145</a><td> * @param {!goog.math.Size} target The target size.<tr><td><a name="l146" href="#l146">146</a><td> * @return {boolean} True if this Size is the same size or smaller than the<tr><td><a name="l147" href="#l147">147</a><td> * target size in both dimensions.<tr><td><a name="l148" href="#l148">148</a><td> */<tr><td><a name="l149" href="#l149">149</a><td>goog.math.Size.prototype.fitsInside = function(target) {<tr><td><a name="l150" href="#l150">150</a><td> return this.width &lt;= target.width &amp;&amp; this.height &lt;= target.height;<tr><td><a name="l151" href="#l151">151</a><td>};<tr><td><a name="l152" href="#l152">152</a><td><tr><td><a name="l153" href="#l153">153</a><td><tr><td><a name="l154" href="#l154">154</a><td>/**<tr><td><a name="l155" href="#l155">155</a><td> * Clamps the width and height parameters downward to integer values.<tr><td><a name="l156" href="#l156">156</a><td> * @return {!goog.math.Size} This size with floored components.<tr><td><a name="l157" href="#l157">157</a><td> */<tr><td><a name="l158" href="#l158">158</a><td>goog.math.Size.prototype.floor = function() {<tr><td><a name="l159" href="#l159">159</a><td> this.width = Math.floor(this.width);<tr><td><a name="l160" href="#l160">160</a><td> this.height = Math.floor(this.height);<tr><td><a name="l161" href="#l161">161</a><td> return this;<tr><td><a name="l162" href="#l162">162</a><td>};<tr><td><a name="l163" href="#l163">163</a><td><tr><td><a name="l164" href="#l164">164</a><td><tr><td><a name="l165" href="#l165">165</a><td>/**<tr><td><a name="l166" href="#l166">166</a><td> * Rounds the width and height parameters to integer values.<tr><td><a name="l167" href="#l167">167</a><td> * @return {!goog.math.Size} This size with rounded components.<tr><td><a name="l168" href="#l168">168</a><td> */<tr><td><a name="l169" href="#l169">169</a><td>goog.math.Size.prototype.round = function() {<tr><td><a name="l170" href="#l170">170</a><td> this.width = Math.round(this.width);<tr><td><a name="l171" href="#l171">171</a><td> this.height = Math.round(this.height);<tr><td><a name="l172" href="#l172">172</a><td> return this;<tr><td><a name="l173" href="#l173">173</a><td>};<tr><td><a name="l174" href="#l174">174</a><td><tr><td><a name="l175" href="#l175">175</a><td><tr><td><a name="l176" href="#l176">176</a><td>/**<tr><td><a name="l177" href="#l177">177</a><td> * Scales this size by the given scale factors. The width and height are scaled<tr><td><a name="l178" href="#l178">178</a><td> * by {@code sx} and {@code opt_sy} respectively. If {@code opt_sy} is not<tr><td><a name="l179" href="#l179">179</a><td> * given, then {@code sx} is used for both the width and height.<tr><td><a name="l180" href="#l180">180</a><td> * @param {number} sx The scale factor to use for the width.<tr><td><a name="l181" href="#l181">181</a><td> * @param {number=} opt_sy The scale factor to use for the height.<tr><td><a name="l182" href="#l182">182</a><td> * @return {!goog.math.Size} This Size object after scaling.<tr><td><a name="l183" href="#l183">183</a><td> */<tr><td><a name="l184" href="#l184">184</a><td>goog.math.Size.prototype.scale = function(sx, opt_sy) {<tr><td><a name="l185" href="#l185">185</a><td> var sy = goog.isNumber(opt_sy) ? opt_sy : sx;<tr><td><a name="l186" href="#l186">186</a><td> this.width *= sx;<tr><td><a name="l187" href="#l187">187</a><td> this.height *= sy;<tr><td><a name="l188" href="#l188">188</a><td> return this;<tr><td><a name="l189" href="#l189">189</a><td>};<tr><td><a name="l190" href="#l190">190</a><td><tr><td><a name="l191" href="#l191">191</a><td><tr><td><a name="l192" href="#l192">192</a><td>/**<tr><td><a name="l193" href="#l193">193</a><td> * Uniformly scales the size to fit inside the dimensions of a given size. The<tr><td><a name="l194" href="#l194">194</a><td> * original aspect ratio will be preserved.<tr><td><a name="l195" href="#l195">195</a><td> *<tr><td><a name="l196" href="#l196">196</a><td> * This function assumes that both Sizes contain strictly positive dimensions.<tr><td><a name="l197" href="#l197">197</a><td> * @param {!goog.math.Size} target The target size.<tr><td><a name="l198" href="#l198">198</a><td> * @return {!goog.math.Size} This Size object, after optional scaling.<tr><td><a name="l199" href="#l199">199</a><td> */<tr><td><a name="l200" href="#l200">200</a><td>goog.math.Size.prototype.scaleToFit = function(target) {<tr><td><a name="l201" href="#l201">201</a><td> var s = this.aspectRatio() &gt; target.aspectRatio() ?<tr><td><a name="l202" href="#l202">202</a><td> target.width / this.width :<tr><td><a name="l203" href="#l203">203</a><td> target.height / this.height;<tr><td><a name="l204" href="#l204">204</a><td><tr><td><a name="l205" href="#l205">205</a><td> return this.scale(s);<tr><td><a name="l206" href="#l206">206</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>size.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/math/size.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2007 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview A utility class for representing two-dimensional sizes.<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><tr><td><a name="l20" href="#l20">20</a><td>goog.provide(&#39;goog.math.Size&#39;);<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><tr><td><a name="l24" href="#l24">24</a><td>/**<tr><td><a name="l25" href="#l25">25</a><td> * Class for representing sizes consisting of a width and height. Undefined<tr><td><a name="l26" href="#l26">26</a><td> * width and height support is deprecated and results in compiler warning.<tr><td><a name="l27" href="#l27">27</a><td> * @param {number} width Width.<tr><td><a name="l28" href="#l28">28</a><td> * @param {number} height Height.<tr><td><a name="l29" href="#l29">29</a><td> * @constructor<tr><td><a name="l30" href="#l30">30</a><td> */<tr><td><a name="l31" href="#l31">31</a><td>goog.math.Size = function(width, height) {<tr><td><a name="l32" href="#l32">32</a><td> /**<tr><td><a name="l33" href="#l33">33</a><td> * Width<tr><td><a name="l34" href="#l34">34</a><td> * @type {number}<tr><td><a name="l35" href="#l35">35</a><td> */<tr><td><a name="l36" href="#l36">36</a><td> this.width = width;<tr><td><a name="l37" href="#l37">37</a><td><tr><td><a name="l38" href="#l38">38</a><td> /**<tr><td><a name="l39" href="#l39">39</a><td> * Height<tr><td><a name="l40" href="#l40">40</a><td> * @type {number}<tr><td><a name="l41" href="#l41">41</a><td> */<tr><td><a name="l42" href="#l42">42</a><td> this.height = height;<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><tr><td><a name="l46" href="#l46">46</a><td>/**<tr><td><a name="l47" href="#l47">47</a><td> * Compares sizes for equality.<tr><td><a name="l48" href="#l48">48</a><td> * @param {goog.math.Size} a A Size.<tr><td><a name="l49" href="#l49">49</a><td> * @param {goog.math.Size} b A Size.<tr><td><a name="l50" href="#l50">50</a><td> * @return {boolean} True iff the sizes have equal widths and equal<tr><td><a name="l51" href="#l51">51</a><td> * heights, or if both are null.<tr><td><a name="l52" href="#l52">52</a><td> */<tr><td><a name="l53" href="#l53">53</a><td>goog.math.Size.equals = function(a, b) {<tr><td><a name="l54" href="#l54">54</a><td> if (a == b) {<tr><td><a name="l55" href="#l55">55</a><td> return true;<tr><td><a name="l56" href="#l56">56</a><td> }<tr><td><a name="l57" href="#l57">57</a><td> if (!a || !b) {<tr><td><a name="l58" href="#l58">58</a><td> return false;<tr><td><a name="l59" href="#l59">59</a><td> }<tr><td><a name="l60" href="#l60">60</a><td> return a.width == b.width &amp;&amp; a.height == b.height;<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> * @return {!goog.math.Size} A new copy of the Size.<tr><td><a name="l66" href="#l66">66</a><td> */<tr><td><a name="l67" href="#l67">67</a><td>goog.math.Size.prototype.clone = function() {<tr><td><a name="l68" href="#l68">68</a><td> return new goog.math.Size(this.width, this.height);<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>if (goog.DEBUG) {<tr><td><a name="l73" href="#l73">73</a><td> /**<tr><td><a name="l74" href="#l74">74</a><td> * Returns a nice string representing size.<tr><td><a name="l75" href="#l75">75</a><td> * @return {string} In the form (50 x 73).<tr><td><a name="l76" href="#l76">76</a><td> * @override<tr><td><a name="l77" href="#l77">77</a><td> */<tr><td><a name="l78" href="#l78">78</a><td> goog.math.Size.prototype.toString = function() {<tr><td><a name="l79" href="#l79">79</a><td> return &#39;(&#39; + this.width + &#39; x &#39; + this.height + &#39;)&#39;;<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><tr><td><a name="l84" href="#l84">84</a><td>/**<tr><td><a name="l85" href="#l85">85</a><td> * @return {number} The longer of the two dimensions in the size.<tr><td><a name="l86" href="#l86">86</a><td> */<tr><td><a name="l87" href="#l87">87</a><td>goog.math.Size.prototype.getLongest = function() {<tr><td><a name="l88" href="#l88">88</a><td> return Math.max(this.width, this.height);<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> * @return {number} The shorter of the two dimensions in the size.<tr><td><a name="l94" href="#l94">94</a><td> */<tr><td><a name="l95" href="#l95">95</a><td>goog.math.Size.prototype.getShortest = function() {<tr><td><a name="l96" href="#l96">96</a><td> return Math.min(this.width, this.height);<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>/**<tr><td><a name="l101" href="#l101">101</a><td> * @return {number} The area of the size (width * height).<tr><td><a name="l102" href="#l102">102</a><td> */<tr><td><a name="l103" href="#l103">103</a><td>goog.math.Size.prototype.area = function() {<tr><td><a name="l104" href="#l104">104</a><td> return this.width * this.height;<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> * @return {number} The perimeter of the size (width + height) * 2.<tr><td><a name="l110" href="#l110">110</a><td> */<tr><td><a name="l111" href="#l111">111</a><td>goog.math.Size.prototype.perimeter = function() {<tr><td><a name="l112" href="#l112">112</a><td> return (this.width + this.height) * 2;<tr><td><a name="l113" href="#l113">113</a><td>};<tr><td><a name="l114" href="#l114">114</a><td><tr><td><a name="l115" href="#l115">115</a><td><tr><td><a name="l116" href="#l116">116</a><td>/**<tr><td><a name="l117" href="#l117">117</a><td> * @return {number} The ratio of the size&#39;s width to its height.<tr><td><a name="l118" href="#l118">118</a><td> */<tr><td><a name="l119" href="#l119">119</a><td>goog.math.Size.prototype.aspectRatio = function() {<tr><td><a name="l120" href="#l120">120</a><td> return this.width / this.height;<tr><td><a name="l121" href="#l121">121</a><td>};<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> * @return {boolean} True if the size has zero area, false if both dimensions<tr><td><a name="l126" href="#l126">126</a><td> * are non-zero numbers.<tr><td><a name="l127" href="#l127">127</a><td> */<tr><td><a name="l128" href="#l128">128</a><td>goog.math.Size.prototype.isEmpty = function() {<tr><td><a name="l129" href="#l129">129</a><td> return !this.area();<tr><td><a name="l130" href="#l130">130</a><td>};<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> * Clamps the width and height parameters upward to integer values.<tr><td><a name="l135" href="#l135">135</a><td> * @return {!goog.math.Size} This size with ceil&#39;d components.<tr><td><a name="l136" href="#l136">136</a><td> */<tr><td><a name="l137" href="#l137">137</a><td>goog.math.Size.prototype.ceil = function() {<tr><td><a name="l138" href="#l138">138</a><td> this.width = Math.ceil(this.width);<tr><td><a name="l139" href="#l139">139</a><td> this.height = Math.ceil(this.height);<tr><td><a name="l140" href="#l140">140</a><td> return this;<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>/**<tr><td><a name="l145" href="#l145">145</a><td> * @param {!goog.math.Size} target The target size.<tr><td><a name="l146" href="#l146">146</a><td> * @return {boolean} True if this Size is the same size or smaller than the<tr><td><a name="l147" href="#l147">147</a><td> * target size in both dimensions.<tr><td><a name="l148" href="#l148">148</a><td> */<tr><td><a name="l149" href="#l149">149</a><td>goog.math.Size.prototype.fitsInside = function(target) {<tr><td><a name="l150" href="#l150">150</a><td> return this.width &lt;= target.width &amp;&amp; this.height &lt;= target.height;<tr><td><a name="l151" href="#l151">151</a><td>};<tr><td><a name="l152" href="#l152">152</a><td><tr><td><a name="l153" href="#l153">153</a><td><tr><td><a name="l154" href="#l154">154</a><td>/**<tr><td><a name="l155" href="#l155">155</a><td> * Clamps the width and height parameters downward to integer values.<tr><td><a name="l156" href="#l156">156</a><td> * @return {!goog.math.Size} This size with floored components.<tr><td><a name="l157" href="#l157">157</a><td> */<tr><td><a name="l158" href="#l158">158</a><td>goog.math.Size.prototype.floor = function() {<tr><td><a name="l159" href="#l159">159</a><td> this.width = Math.floor(this.width);<tr><td><a name="l160" href="#l160">160</a><td> this.height = Math.floor(this.height);<tr><td><a name="l161" href="#l161">161</a><td> return this;<tr><td><a name="l162" href="#l162">162</a><td>};<tr><td><a name="l163" href="#l163">163</a><td><tr><td><a name="l164" href="#l164">164</a><td><tr><td><a name="l165" href="#l165">165</a><td>/**<tr><td><a name="l166" href="#l166">166</a><td> * Rounds the width and height parameters to integer values.<tr><td><a name="l167" href="#l167">167</a><td> * @return {!goog.math.Size} This size with rounded components.<tr><td><a name="l168" href="#l168">168</a><td> */<tr><td><a name="l169" href="#l169">169</a><td>goog.math.Size.prototype.round = function() {<tr><td><a name="l170" href="#l170">170</a><td> this.width = Math.round(this.width);<tr><td><a name="l171" href="#l171">171</a><td> this.height = Math.round(this.height);<tr><td><a name="l172" href="#l172">172</a><td> return this;<tr><td><a name="l173" href="#l173">173</a><td>};<tr><td><a name="l174" href="#l174">174</a><td><tr><td><a name="l175" href="#l175">175</a><td><tr><td><a name="l176" href="#l176">176</a><td>/**<tr><td><a name="l177" href="#l177">177</a><td> * Scales this size by the given scale factors. The width and height are scaled<tr><td><a name="l178" href="#l178">178</a><td> * by {@code sx} and {@code opt_sy} respectively. If {@code opt_sy} is not<tr><td><a name="l179" href="#l179">179</a><td> * given, then {@code sx} is used for both the width and height.<tr><td><a name="l180" href="#l180">180</a><td> * @param {number} sx The scale factor to use for the width.<tr><td><a name="l181" href="#l181">181</a><td> * @param {number=} opt_sy The scale factor to use for the height.<tr><td><a name="l182" href="#l182">182</a><td> * @return {!goog.math.Size} This Size object after scaling.<tr><td><a name="l183" href="#l183">183</a><td> */<tr><td><a name="l184" href="#l184">184</a><td>goog.math.Size.prototype.scale = function(sx, opt_sy) {<tr><td><a name="l185" href="#l185">185</a><td> var sy = goog.isNumber(opt_sy) ? opt_sy : sx;<tr><td><a name="l186" href="#l186">186</a><td> this.width *= sx;<tr><td><a name="l187" href="#l187">187</a><td> this.height *= sy;<tr><td><a name="l188" href="#l188">188</a><td> return this;<tr><td><a name="l189" href="#l189">189</a><td>};<tr><td><a name="l190" href="#l190">190</a><td><tr><td><a name="l191" href="#l191">191</a><td><tr><td><a name="l192" href="#l192">192</a><td>/**<tr><td><a name="l193" href="#l193">193</a><td> * Uniformly scales the size to fit inside the dimensions of a given size. The<tr><td><a name="l194" href="#l194">194</a><td> * original aspect ratio will be preserved.<tr><td><a name="l195" href="#l195">195</a><td> *<tr><td><a name="l196" href="#l196">196</a><td> * This function assumes that both Sizes contain strictly positive dimensions.<tr><td><a name="l197" href="#l197">197</a><td> * @param {!goog.math.Size} target The target size.<tr><td><a name="l198" href="#l198">198</a><td> * @return {!goog.math.Size} This Size object, after optional scaling.<tr><td><a name="l199" href="#l199">199</a><td> */<tr><td><a name="l200" href="#l200">200</a><td>goog.math.Size.prototype.scaleToFit = function(target) {<tr><td><a name="l201" href="#l201">201</a><td> var s = this.aspectRatio() &gt; target.aspectRatio() ?<tr><td><a name="l202" href="#l202">202</a><td> target.width / this.width :<tr><td><a name="l203" href="#l203">203</a><td> target.height / this.height;<tr><td><a name="l204" href="#l204">204</a><td><tr><td><a name="l205" href="#l205">205</a><td> return this.scale(s);<tr><td><a name="l206" href="#l206">206</a><td>};</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="../../../../license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../../types.js"></script><script src="../../../../dossier.js"></script>
package/docs/source/lib/goog/net/wrapperxmlhttpfactory.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>wrapperxmlhttpfactory.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/net/wrapperxmlhttpfactory.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2010 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Implementation of XmlHttpFactory which allows construction from<tr><td><a name="l17" href="#l17">17</a><td> * simple factory methods.<tr><td><a name="l18" href="#l18">18</a><td> * @author dbk@google.com (David Barrett-Kahn)<tr><td><a name="l19" href="#l19">19</a><td> */<tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;goog.net.WrapperXmlHttpFactory&#39;);<tr><td><a name="l22" href="#l22">22</a><td><tr><td><a name="l23" href="#l23">23</a><td>/** @suppress {extraRequire} Typedef. */<tr><td><a name="l24" href="#l24">24</a><td>goog.require(&#39;goog.net.XhrLike&#39;);<tr><td><a name="l25" href="#l25">25</a><td>goog.require(&#39;goog.net.XmlHttpFactory&#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 xhr factory subclass which can be constructed using two factory methods.<tr><td><a name="l31" href="#l31">31</a><td> * This exists partly to allow the preservation of goog.net.XmlHttp.setFactory()<tr><td><a name="l32" href="#l32">32</a><td> * with an unchanged signature.<tr><td><a name="l33" href="#l33">33</a><td> * @param {function():!goog.net.XhrLike.OrNative} xhrFactory<tr><td><a name="l34" href="#l34">34</a><td> * A function which returns a new XHR object.<tr><td><a name="l35" href="#l35">35</a><td> * @param {function():!Object} optionsFactory A function which returns the<tr><td><a name="l36" href="#l36">36</a><td> * options associated with xhr objects from this factory.<tr><td><a name="l37" href="#l37">37</a><td> * @extends {goog.net.XmlHttpFactory}<tr><td><a name="l38" href="#l38">38</a><td> * @constructor<tr><td><a name="l39" href="#l39">39</a><td> * @final<tr><td><a name="l40" href="#l40">40</a><td> */<tr><td><a name="l41" href="#l41">41</a><td>goog.net.WrapperXmlHttpFactory = function(xhrFactory, optionsFactory) {<tr><td><a name="l42" href="#l42">42</a><td> goog.net.XmlHttpFactory.call(this);<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> * XHR factory method.<tr><td><a name="l46" href="#l46">46</a><td> * @type {function() : !goog.net.XhrLike.OrNative}<tr><td><a name="l47" href="#l47">47</a><td> * @private<tr><td><a name="l48" href="#l48">48</a><td> */<tr><td><a name="l49" href="#l49">49</a><td> this.xhrFactory_ = xhrFactory;<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> * Options factory method.<tr><td><a name="l53" href="#l53">53</a><td> * @type {function() : !Object}<tr><td><a name="l54" href="#l54">54</a><td> * @private<tr><td><a name="l55" href="#l55">55</a><td> */<tr><td><a name="l56" href="#l56">56</a><td> this.optionsFactory_ = optionsFactory;<tr><td><a name="l57" href="#l57">57</a><td>};<tr><td><a name="l58" href="#l58">58</a><td>goog.inherits(goog.net.WrapperXmlHttpFactory, goog.net.XmlHttpFactory);<tr><td><a name="l59" href="#l59">59</a><td><tr><td><a name="l60" href="#l60">60</a><td><tr><td><a name="l61" href="#l61">61</a><td>/** @override */<tr><td><a name="l62" href="#l62">62</a><td>goog.net.WrapperXmlHttpFactory.prototype.createInstance = function() {<tr><td><a name="l63" href="#l63">63</a><td> return this.xhrFactory_();<tr><td><a name="l64" href="#l64">64</a><td>};<tr><td><a name="l65" href="#l65">65</a><td><tr><td><a name="l66" href="#l66">66</a><td><tr><td><a name="l67" href="#l67">67</a><td>/** @override */<tr><td><a name="l68" href="#l68">68</a><td>goog.net.WrapperXmlHttpFactory.prototype.getOptions = function() {<tr><td><a name="l69" href="#l69">69</a><td> return this.optionsFactory_();<tr><td><a name="l70" href="#l70">70</a><td>};<tr><td><a name="l71" href="#l71">71</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>wrapperxmlhttpfactory.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/net/wrapperxmlhttpfactory.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2010 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Implementation of XmlHttpFactory which allows construction from<tr><td><a name="l17" href="#l17">17</a><td> * simple factory methods.<tr><td><a name="l18" href="#l18">18</a><td> * @author dbk@google.com (David Barrett-Kahn)<tr><td><a name="l19" href="#l19">19</a><td> */<tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;goog.net.WrapperXmlHttpFactory&#39;);<tr><td><a name="l22" href="#l22">22</a><td><tr><td><a name="l23" href="#l23">23</a><td>/** @suppress {extraRequire} Typedef. */<tr><td><a name="l24" href="#l24">24</a><td>goog.require(&#39;goog.net.XhrLike&#39;);<tr><td><a name="l25" href="#l25">25</a><td>goog.require(&#39;goog.net.XmlHttpFactory&#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 xhr factory subclass which can be constructed using two factory methods.<tr><td><a name="l31" href="#l31">31</a><td> * This exists partly to allow the preservation of goog.net.XmlHttp.setFactory()<tr><td><a name="l32" href="#l32">32</a><td> * with an unchanged signature.<tr><td><a name="l33" href="#l33">33</a><td> * @param {function():!goog.net.XhrLike.OrNative} xhrFactory<tr><td><a name="l34" href="#l34">34</a><td> * A function which returns a new XHR object.<tr><td><a name="l35" href="#l35">35</a><td> * @param {function():!Object} optionsFactory A function which returns the<tr><td><a name="l36" href="#l36">36</a><td> * options associated with xhr objects from this factory.<tr><td><a name="l37" href="#l37">37</a><td> * @extends {goog.net.XmlHttpFactory}<tr><td><a name="l38" href="#l38">38</a><td> * @constructor<tr><td><a name="l39" href="#l39">39</a><td> * @final<tr><td><a name="l40" href="#l40">40</a><td> */<tr><td><a name="l41" href="#l41">41</a><td>goog.net.WrapperXmlHttpFactory = function(xhrFactory, optionsFactory) {<tr><td><a name="l42" href="#l42">42</a><td> goog.net.XmlHttpFactory.call(this);<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> * XHR factory method.<tr><td><a name="l46" href="#l46">46</a><td> * @type {function() : !goog.net.XhrLike.OrNative}<tr><td><a name="l47" href="#l47">47</a><td> * @private<tr><td><a name="l48" href="#l48">48</a><td> */<tr><td><a name="l49" href="#l49">49</a><td> this.xhrFactory_ = xhrFactory;<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> * Options factory method.<tr><td><a name="l53" href="#l53">53</a><td> * @type {function() : !Object}<tr><td><a name="l54" href="#l54">54</a><td> * @private<tr><td><a name="l55" href="#l55">55</a><td> */<tr><td><a name="l56" href="#l56">56</a><td> this.optionsFactory_ = optionsFactory;<tr><td><a name="l57" href="#l57">57</a><td>};<tr><td><a name="l58" href="#l58">58</a><td>goog.inherits(goog.net.WrapperXmlHttpFactory, goog.net.XmlHttpFactory);<tr><td><a name="l59" href="#l59">59</a><td><tr><td><a name="l60" href="#l60">60</a><td><tr><td><a name="l61" href="#l61">61</a><td>/** @override */<tr><td><a name="l62" href="#l62">62</a><td>goog.net.WrapperXmlHttpFactory.prototype.createInstance = function() {<tr><td><a name="l63" href="#l63">63</a><td> return this.xhrFactory_();<tr><td><a name="l64" href="#l64">64</a><td>};<tr><td><a name="l65" href="#l65">65</a><td><tr><td><a name="l66" href="#l66">66</a><td><tr><td><a name="l67" href="#l67">67</a><td>/** @override */<tr><td><a name="l68" href="#l68">68</a><td>goog.net.WrapperXmlHttpFactory.prototype.getOptions = function() {<tr><td><a name="l69" href="#l69">69</a><td> return this.optionsFactory_();<tr><td><a name="l70" href="#l70">70</a><td>};<tr><td><a name="l71" href="#l71">71</a><td></table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="../../../../license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../../types.js"></script><script src="../../../../dossier.js"></script>
package/docs/source/lib/goog/net/xhrlike.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>xhrlike.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/net/xhrlike.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2013 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>goog.provide(&#39;goog.net.XhrLike&#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>/**<tr><td><a name="l20" href="#l20">20</a><td> * Interface for the common parts of XMLHttpRequest.<tr><td><a name="l21" href="#l21">21</a><td> *<tr><td><a name="l22" href="#l22">22</a><td> * Mostly copied from externs/w3c_xml.js.<tr><td><a name="l23" href="#l23">23</a><td> *<tr><td><a name="l24" href="#l24">24</a><td> * @interface<tr><td><a name="l25" href="#l25">25</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/<tr><td><a name="l26" href="#l26">26</a><td> */<tr><td><a name="l27" href="#l27">27</a><td>goog.net.XhrLike = function() {};<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>/**<tr><td><a name="l31" href="#l31">31</a><td> * Typedef that refers to either native or custom-implemented XHR objects.<tr><td><a name="l32" href="#l32">32</a><td> * @typedef {!goog.net.XhrLike|!XMLHttpRequest}<tr><td><a name="l33" href="#l33">33</a><td> */<tr><td><a name="l34" href="#l34">34</a><td>goog.net.XhrLike.OrNative;<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> * @type {function()|null|undefined}<tr><td><a name="l39" href="#l39">39</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#handler-xhr-onreadystatechange<tr><td><a name="l40" href="#l40">40</a><td> */<tr><td><a name="l41" href="#l41">41</a><td>goog.net.XhrLike.prototype.onreadystatechange;<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> * @type {string}<tr><td><a name="l46" href="#l46">46</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#the-responsetext-attribute<tr><td><a name="l47" href="#l47">47</a><td> */<tr><td><a name="l48" href="#l48">48</a><td>goog.net.XhrLike.prototype.responseText;<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> * @type {Document}<tr><td><a name="l53" href="#l53">53</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#the-responsexml-attribute<tr><td><a name="l54" href="#l54">54</a><td> */<tr><td><a name="l55" href="#l55">55</a><td>goog.net.XhrLike.prototype.responseXML;<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>/**<tr><td><a name="l59" href="#l59">59</a><td> * @type {number}<tr><td><a name="l60" href="#l60">60</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#readystate<tr><td><a name="l61" href="#l61">61</a><td> */<tr><td><a name="l62" href="#l62">62</a><td>goog.net.XhrLike.prototype.readyState;<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>/**<tr><td><a name="l66" href="#l66">66</a><td> * @type {number}<tr><td><a name="l67" href="#l67">67</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#status<tr><td><a name="l68" href="#l68">68</a><td> */<tr><td><a name="l69" href="#l69">69</a><td>goog.net.XhrLike.prototype.status;<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> * @type {string}<tr><td><a name="l74" href="#l74">74</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#statustext<tr><td><a name="l75" href="#l75">75</a><td> */<tr><td><a name="l76" href="#l76">76</a><td>goog.net.XhrLike.prototype.statusText;<tr><td><a name="l77" href="#l77">77</a><td><tr><td><a name="l78" href="#l78">78</a><td><tr><td><a name="l79" href="#l79">79</a><td>/**<tr><td><a name="l80" href="#l80">80</a><td> * @param {string} method<tr><td><a name="l81" href="#l81">81</a><td> * @param {string} url<tr><td><a name="l82" href="#l82">82</a><td> * @param {?boolean=} opt_async<tr><td><a name="l83" href="#l83">83</a><td> * @param {?string=} opt_user<tr><td><a name="l84" href="#l84">84</a><td> * @param {?string=} opt_password<tr><td><a name="l85" href="#l85">85</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#the-open()-method<tr><td><a name="l86" href="#l86">86</a><td> */<tr><td><a name="l87" href="#l87">87</a><td>goog.net.XhrLike.prototype.open = function(method, url, opt_async, opt_user,<tr><td><a name="l88" href="#l88">88</a><td> opt_password) {};<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> * @param {ArrayBuffer|ArrayBufferView|Blob|Document|FormData|string=} opt_data<tr><td><a name="l93" href="#l93">93</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#the-send()-method<tr><td><a name="l94" href="#l94">94</a><td> */<tr><td><a name="l95" href="#l95">95</a><td>goog.net.XhrLike.prototype.send = function(opt_data) {};<tr><td><a name="l96" href="#l96">96</a><td><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> * @see http://www.w3.org/TR/XMLHttpRequest/#the-abort()-method<tr><td><a name="l100" href="#l100">100</a><td> */<tr><td><a name="l101" href="#l101">101</a><td>goog.net.XhrLike.prototype.abort = function() {};<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>/**<tr><td><a name="l105" href="#l105">105</a><td> * @param {string} header<tr><td><a name="l106" href="#l106">106</a><td> * @param {string} value<tr><td><a name="l107" href="#l107">107</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#the-setrequestheader()-method<tr><td><a name="l108" href="#l108">108</a><td> */<tr><td><a name="l109" href="#l109">109</a><td>goog.net.XhrLike.prototype.setRequestHeader = function(header, value) {};<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> * @param {string} header<tr><td><a name="l114" href="#l114">114</a><td> * @return {string}<tr><td><a name="l115" href="#l115">115</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#the-getresponseheader()-method<tr><td><a name="l116" href="#l116">116</a><td> */<tr><td><a name="l117" href="#l117">117</a><td>goog.net.XhrLike.prototype.getResponseHeader = function(header) {};<tr><td><a name="l118" href="#l118">118</a><td><tr><td><a name="l119" href="#l119">119</a><td><tr><td><a name="l120" href="#l120">120</a><td>/**<tr><td><a name="l121" href="#l121">121</a><td> * @return {string}<tr><td><a name="l122" href="#l122">122</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#the-getallresponseheaders()-method<tr><td><a name="l123" href="#l123">123</a><td> */<tr><td><a name="l124" href="#l124">124</a><td>goog.net.XhrLike.prototype.getAllResponseHeaders = function() {};</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>xhrlike.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/net/xhrlike.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2013 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>goog.provide(&#39;goog.net.XhrLike&#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>/**<tr><td><a name="l20" href="#l20">20</a><td> * Interface for the common parts of XMLHttpRequest.<tr><td><a name="l21" href="#l21">21</a><td> *<tr><td><a name="l22" href="#l22">22</a><td> * Mostly copied from externs/w3c_xml.js.<tr><td><a name="l23" href="#l23">23</a><td> *<tr><td><a name="l24" href="#l24">24</a><td> * @interface<tr><td><a name="l25" href="#l25">25</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/<tr><td><a name="l26" href="#l26">26</a><td> */<tr><td><a name="l27" href="#l27">27</a><td>goog.net.XhrLike = function() {};<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>/**<tr><td><a name="l31" href="#l31">31</a><td> * Typedef that refers to either native or custom-implemented XHR objects.<tr><td><a name="l32" href="#l32">32</a><td> * @typedef {!goog.net.XhrLike|!XMLHttpRequest}<tr><td><a name="l33" href="#l33">33</a><td> */<tr><td><a name="l34" href="#l34">34</a><td>goog.net.XhrLike.OrNative;<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> * @type {function()|null|undefined}<tr><td><a name="l39" href="#l39">39</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#handler-xhr-onreadystatechange<tr><td><a name="l40" href="#l40">40</a><td> */<tr><td><a name="l41" href="#l41">41</a><td>goog.net.XhrLike.prototype.onreadystatechange;<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> * @type {string}<tr><td><a name="l46" href="#l46">46</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#the-responsetext-attribute<tr><td><a name="l47" href="#l47">47</a><td> */<tr><td><a name="l48" href="#l48">48</a><td>goog.net.XhrLike.prototype.responseText;<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> * @type {Document}<tr><td><a name="l53" href="#l53">53</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#the-responsexml-attribute<tr><td><a name="l54" href="#l54">54</a><td> */<tr><td><a name="l55" href="#l55">55</a><td>goog.net.XhrLike.prototype.responseXML;<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>/**<tr><td><a name="l59" href="#l59">59</a><td> * @type {number}<tr><td><a name="l60" href="#l60">60</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#readystate<tr><td><a name="l61" href="#l61">61</a><td> */<tr><td><a name="l62" href="#l62">62</a><td>goog.net.XhrLike.prototype.readyState;<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>/**<tr><td><a name="l66" href="#l66">66</a><td> * @type {number}<tr><td><a name="l67" href="#l67">67</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#status<tr><td><a name="l68" href="#l68">68</a><td> */<tr><td><a name="l69" href="#l69">69</a><td>goog.net.XhrLike.prototype.status;<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> * @type {string}<tr><td><a name="l74" href="#l74">74</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#statustext<tr><td><a name="l75" href="#l75">75</a><td> */<tr><td><a name="l76" href="#l76">76</a><td>goog.net.XhrLike.prototype.statusText;<tr><td><a name="l77" href="#l77">77</a><td><tr><td><a name="l78" href="#l78">78</a><td><tr><td><a name="l79" href="#l79">79</a><td>/**<tr><td><a name="l80" href="#l80">80</a><td> * @param {string} method<tr><td><a name="l81" href="#l81">81</a><td> * @param {string} url<tr><td><a name="l82" href="#l82">82</a><td> * @param {?boolean=} opt_async<tr><td><a name="l83" href="#l83">83</a><td> * @param {?string=} opt_user<tr><td><a name="l84" href="#l84">84</a><td> * @param {?string=} opt_password<tr><td><a name="l85" href="#l85">85</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#the-open()-method<tr><td><a name="l86" href="#l86">86</a><td> */<tr><td><a name="l87" href="#l87">87</a><td>goog.net.XhrLike.prototype.open = function(method, url, opt_async, opt_user,<tr><td><a name="l88" href="#l88">88</a><td> opt_password) {};<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> * @param {ArrayBuffer|ArrayBufferView|Blob|Document|FormData|string=} opt_data<tr><td><a name="l93" href="#l93">93</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#the-send()-method<tr><td><a name="l94" href="#l94">94</a><td> */<tr><td><a name="l95" href="#l95">95</a><td>goog.net.XhrLike.prototype.send = function(opt_data) {};<tr><td><a name="l96" href="#l96">96</a><td><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> * @see http://www.w3.org/TR/XMLHttpRequest/#the-abort()-method<tr><td><a name="l100" href="#l100">100</a><td> */<tr><td><a name="l101" href="#l101">101</a><td>goog.net.XhrLike.prototype.abort = function() {};<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>/**<tr><td><a name="l105" href="#l105">105</a><td> * @param {string} header<tr><td><a name="l106" href="#l106">106</a><td> * @param {string} value<tr><td><a name="l107" href="#l107">107</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#the-setrequestheader()-method<tr><td><a name="l108" href="#l108">108</a><td> */<tr><td><a name="l109" href="#l109">109</a><td>goog.net.XhrLike.prototype.setRequestHeader = function(header, value) {};<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> * @param {string} header<tr><td><a name="l114" href="#l114">114</a><td> * @return {string}<tr><td><a name="l115" href="#l115">115</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#the-getresponseheader()-method<tr><td><a name="l116" href="#l116">116</a><td> */<tr><td><a name="l117" href="#l117">117</a><td>goog.net.XhrLike.prototype.getResponseHeader = function(header) {};<tr><td><a name="l118" href="#l118">118</a><td><tr><td><a name="l119" href="#l119">119</a><td><tr><td><a name="l120" href="#l120">120</a><td>/**<tr><td><a name="l121" href="#l121">121</a><td> * @return {string}<tr><td><a name="l122" href="#l122">122</a><td> * @see http://www.w3.org/TR/XMLHttpRequest/#the-getallresponseheaders()-method<tr><td><a name="l123" href="#l123">123</a><td> */<tr><td><a name="l124" href="#l124">124</a><td>goog.net.XhrLike.prototype.getAllResponseHeaders = function() {};</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="../../../../license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../../types.js"></script><script src="../../../../dossier.js"></script>
package/docs/source/lib/goog/net/xmlhttp.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>xmlhttp.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/net/xmlhttp.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2006 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Low level handling of XMLHttpRequest.<tr><td><a name="l17" href="#l17">17</a><td> * @author arv@google.com (Erik Arvidsson)<tr><td><a name="l18" href="#l18">18</a><td> * @author dbk@google.com (David Barrett-Kahn)<tr><td><a name="l19" href="#l19">19</a><td> */<tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;goog.net.DefaultXmlHttpFactory&#39;);<tr><td><a name="l22" href="#l22">22</a><td>goog.provide(&#39;goog.net.XmlHttp&#39;);<tr><td><a name="l23" href="#l23">23</a><td>goog.provide(&#39;goog.net.XmlHttp.OptionType&#39;);<tr><td><a name="l24" href="#l24">24</a><td>goog.provide(&#39;goog.net.XmlHttp.ReadyState&#39;);<tr><td><a name="l25" href="#l25">25</a><td>goog.provide(&#39;goog.net.XmlHttpDefines&#39;);<tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td>goog.require(&#39;goog.asserts&#39;);<tr><td><a name="l28" href="#l28">28</a><td>goog.require(&#39;goog.net.WrapperXmlHttpFactory&#39;);<tr><td><a name="l29" href="#l29">29</a><td>goog.require(&#39;goog.net.XmlHttpFactory&#39;);<tr><td><a name="l30" href="#l30">30</a><td><tr><td><a name="l31" href="#l31">31</a><td><tr><td><a name="l32" href="#l32">32</a><td>/**<tr><td><a name="l33" href="#l33">33</a><td> * Static class for creating XMLHttpRequest objects.<tr><td><a name="l34" href="#l34">34</a><td> * @return {!goog.net.XhrLike.OrNative} A new XMLHttpRequest object.<tr><td><a name="l35" href="#l35">35</a><td> */<tr><td><a name="l36" href="#l36">36</a><td>goog.net.XmlHttp = function() {<tr><td><a name="l37" href="#l37">37</a><td> return goog.net.XmlHttp.factory_.createInstance();<tr><td><a name="l38" href="#l38">38</a><td>};<tr><td><a name="l39" href="#l39">39</a><td><tr><td><a name="l40" href="#l40">40</a><td><tr><td><a name="l41" href="#l41">41</a><td>/**<tr><td><a name="l42" href="#l42">42</a><td> * @define {boolean} Whether to assume XMLHttpRequest exists. Setting this to<tr><td><a name="l43" href="#l43">43</a><td> * true bypasses the ActiveX probing code.<tr><td><a name="l44" href="#l44">44</a><td> * NOTE(user): Due to the way JSCompiler works, this define *will not* strip<tr><td><a name="l45" href="#l45">45</a><td> * out the ActiveX probing code from binaries. To achieve this, use<tr><td><a name="l46" href="#l46">46</a><td> * {@code goog.net.XmlHttpDefines.ASSUME_NATIVE_XHR} instead.<tr><td><a name="l47" href="#l47">47</a><td> * TODO(user): Collapse both defines.<tr><td><a name="l48" href="#l48">48</a><td> */<tr><td><a name="l49" href="#l49">49</a><td>goog.define(&#39;goog.net.XmlHttp.ASSUME_NATIVE_XHR&#39;, false);<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>/** @const */<tr><td><a name="l53" href="#l53">53</a><td>goog.net.XmlHttpDefines = {};<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> * @define {boolean} Whether to assume XMLHttpRequest exists. Setting this to<tr><td><a name="l58" href="#l58">58</a><td> * true eliminates the ActiveX probing code.<tr><td><a name="l59" href="#l59">59</a><td> */<tr><td><a name="l60" href="#l60">60</a><td>goog.define(&#39;goog.net.XmlHttpDefines.ASSUME_NATIVE_XHR&#39;, false);<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> * Gets the options to use with the XMLHttpRequest objects obtained using<tr><td><a name="l65" href="#l65">65</a><td> * the static methods.<tr><td><a name="l66" href="#l66">66</a><td> * @return {Object} The options.<tr><td><a name="l67" href="#l67">67</a><td> */<tr><td><a name="l68" href="#l68">68</a><td>goog.net.XmlHttp.getOptions = function() {<tr><td><a name="l69" href="#l69">69</a><td> return goog.net.XmlHttp.factory_.getOptions();<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>/**<tr><td><a name="l74" href="#l74">74</a><td> * Type of options that an XmlHttp object can have.<tr><td><a name="l75" href="#l75">75</a><td> * @enum {number}<tr><td><a name="l76" href="#l76">76</a><td> */<tr><td><a name="l77" href="#l77">77</a><td>goog.net.XmlHttp.OptionType = {<tr><td><a name="l78" href="#l78">78</a><td> /**<tr><td><a name="l79" href="#l79">79</a><td> * Whether a goog.nullFunction should be used to clear the onreadystatechange<tr><td><a name="l80" href="#l80">80</a><td> * handler instead of null.<tr><td><a name="l81" href="#l81">81</a><td> */<tr><td><a name="l82" href="#l82">82</a><td> USE_NULL_FUNCTION: 0,<tr><td><a name="l83" href="#l83">83</a><td><tr><td><a name="l84" href="#l84">84</a><td> /**<tr><td><a name="l85" href="#l85">85</a><td> * NOTE(user): In IE if send() errors on a *local* request the readystate<tr><td><a name="l86" href="#l86">86</a><td> * is still changed to COMPLETE. We need to ignore it and allow the<tr><td><a name="l87" href="#l87">87</a><td> * try/catch around send() to pick up the error.<tr><td><a name="l88" href="#l88">88</a><td> */<tr><td><a name="l89" href="#l89">89</a><td> LOCAL_REQUEST_ERROR: 1<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>/**<tr><td><a name="l94" href="#l94">94</a><td> * Status constants for XMLHTTP, matches:<tr><td><a name="l95" href="#l95">95</a><td> * http://msdn.microsoft.com/library/default.asp?url=/library/<tr><td><a name="l96" href="#l96">96</a><td> * en-us/xmlsdk/html/0e6a34e4-f90c-489d-acff-cb44242fafc6.asp<tr><td><a name="l97" href="#l97">97</a><td> * @enum {number}<tr><td><a name="l98" href="#l98">98</a><td> */<tr><td><a name="l99" href="#l99">99</a><td>goog.net.XmlHttp.ReadyState = {<tr><td><a name="l100" href="#l100">100</a><td> /**<tr><td><a name="l101" href="#l101">101</a><td> * Constant for when xmlhttprequest.readyState is uninitialized<tr><td><a name="l102" href="#l102">102</a><td> */<tr><td><a name="l103" href="#l103">103</a><td> UNINITIALIZED: 0,<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> * Constant for when xmlhttprequest.readyState is loading.<tr><td><a name="l107" href="#l107">107</a><td> */<tr><td><a name="l108" href="#l108">108</a><td> LOADING: 1,<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> * Constant for when xmlhttprequest.readyState is loaded.<tr><td><a name="l112" href="#l112">112</a><td> */<tr><td><a name="l113" href="#l113">113</a><td> LOADED: 2,<tr><td><a name="l114" href="#l114">114</a><td><tr><td><a name="l115" href="#l115">115</a><td> /**<tr><td><a name="l116" href="#l116">116</a><td> * Constant for when xmlhttprequest.readyState is in an interactive state.<tr><td><a name="l117" href="#l117">117</a><td> */<tr><td><a name="l118" href="#l118">118</a><td> INTERACTIVE: 3,<tr><td><a name="l119" href="#l119">119</a><td><tr><td><a name="l120" href="#l120">120</a><td> /**<tr><td><a name="l121" href="#l121">121</a><td> * Constant for when xmlhttprequest.readyState is completed<tr><td><a name="l122" href="#l122">122</a><td> */<tr><td><a name="l123" href="#l123">123</a><td> COMPLETE: 4<tr><td><a name="l124" href="#l124">124</a><td>};<tr><td><a name="l125" href="#l125">125</a><td><tr><td><a name="l126" href="#l126">126</a><td><tr><td><a name="l127" href="#l127">127</a><td>/**<tr><td><a name="l128" href="#l128">128</a><td> * The global factory instance for creating XMLHttpRequest objects.<tr><td><a name="l129" href="#l129">129</a><td> * @type {goog.net.XmlHttpFactory}<tr><td><a name="l130" href="#l130">130</a><td> * @private<tr><td><a name="l131" href="#l131">131</a><td> */<tr><td><a name="l132" href="#l132">132</a><td>goog.net.XmlHttp.factory_;<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> * Sets the factories for creating XMLHttpRequest objects and their options.<tr><td><a name="l137" href="#l137">137</a><td> * @param {Function} factory The factory for XMLHttpRequest objects.<tr><td><a name="l138" href="#l138">138</a><td> * @param {Function} optionsFactory The factory for options.<tr><td><a name="l139" href="#l139">139</a><td> * @deprecated Use setGlobalFactory instead.<tr><td><a name="l140" href="#l140">140</a><td> */<tr><td><a name="l141" href="#l141">141</a><td>goog.net.XmlHttp.setFactory = function(factory, optionsFactory) {<tr><td><a name="l142" href="#l142">142</a><td> goog.net.XmlHttp.setGlobalFactory(new goog.net.WrapperXmlHttpFactory(<tr><td><a name="l143" href="#l143">143</a><td> goog.asserts.assert(factory),<tr><td><a name="l144" href="#l144">144</a><td> goog.asserts.assert(optionsFactory)));<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> * Sets the global factory object.<tr><td><a name="l150" href="#l150">150</a><td> * @param {!goog.net.XmlHttpFactory} factory New global factory object.<tr><td><a name="l151" href="#l151">151</a><td> */<tr><td><a name="l152" href="#l152">152</a><td>goog.net.XmlHttp.setGlobalFactory = function(factory) {<tr><td><a name="l153" href="#l153">153</a><td> goog.net.XmlHttp.factory_ = factory;<tr><td><a name="l154" href="#l154">154</a><td>};<tr><td><a name="l155" href="#l155">155</a><td><tr><td><a name="l156" href="#l156">156</a><td><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> * Default factory to use when creating xhr objects. You probably shouldn&#39;t be<tr><td><a name="l160" href="#l160">160</a><td> * instantiating this directly, but rather using it via goog.net.XmlHttp.<tr><td><a name="l161" href="#l161">161</a><td> * @extends {goog.net.XmlHttpFactory}<tr><td><a name="l162" href="#l162">162</a><td> * @constructor<tr><td><a name="l163" href="#l163">163</a><td> */<tr><td><a name="l164" href="#l164">164</a><td>goog.net.DefaultXmlHttpFactory = function() {<tr><td><a name="l165" href="#l165">165</a><td> goog.net.XmlHttpFactory.call(this);<tr><td><a name="l166" href="#l166">166</a><td>};<tr><td><a name="l167" href="#l167">167</a><td>goog.inherits(goog.net.DefaultXmlHttpFactory, goog.net.XmlHttpFactory);<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>/** @override */<tr><td><a name="l171" href="#l171">171</a><td>goog.net.DefaultXmlHttpFactory.prototype.createInstance = function() {<tr><td><a name="l172" href="#l172">172</a><td> var progId = this.getProgId_();<tr><td><a name="l173" href="#l173">173</a><td> if (progId) {<tr><td><a name="l174" href="#l174">174</a><td> return new ActiveXObject(progId);<tr><td><a name="l175" href="#l175">175</a><td> } else {<tr><td><a name="l176" href="#l176">176</a><td> return new XMLHttpRequest();<tr><td><a name="l177" href="#l177">177</a><td> }<tr><td><a name="l178" href="#l178">178</a><td>};<tr><td><a name="l179" href="#l179">179</a><td><tr><td><a name="l180" href="#l180">180</a><td><tr><td><a name="l181" href="#l181">181</a><td>/** @override */<tr><td><a name="l182" href="#l182">182</a><td>goog.net.DefaultXmlHttpFactory.prototype.internalGetOptions = function() {<tr><td><a name="l183" href="#l183">183</a><td> var progId = this.getProgId_();<tr><td><a name="l184" href="#l184">184</a><td> var options = {};<tr><td><a name="l185" href="#l185">185</a><td> if (progId) {<tr><td><a name="l186" href="#l186">186</a><td> options[goog.net.XmlHttp.OptionType.USE_NULL_FUNCTION] = true;<tr><td><a name="l187" href="#l187">187</a><td> options[goog.net.XmlHttp.OptionType.LOCAL_REQUEST_ERROR] = true;<tr><td><a name="l188" href="#l188">188</a><td> }<tr><td><a name="l189" href="#l189">189</a><td> return options;<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>/**<tr><td><a name="l194" href="#l194">194</a><td> * The ActiveX PROG ID string to use to create xhr&#39;s in IE. Lazily initialized.<tr><td><a name="l195" href="#l195">195</a><td> * @type {string|undefined}<tr><td><a name="l196" href="#l196">196</a><td> * @private<tr><td><a name="l197" href="#l197">197</a><td> */<tr><td><a name="l198" href="#l198">198</a><td>goog.net.DefaultXmlHttpFactory.prototype.ieProgId_;<tr><td><a name="l199" href="#l199">199</a><td><tr><td><a name="l200" href="#l200">200</a><td><tr><td><a name="l201" href="#l201">201</a><td>/**<tr><td><a name="l202" href="#l202">202</a><td> * Initialize the private state used by other functions.<tr><td><a name="l203" href="#l203">203</a><td> * @return {string} The ActiveX PROG ID string to use to create xhr&#39;s in IE.<tr><td><a name="l204" href="#l204">204</a><td> * @private<tr><td><a name="l205" href="#l205">205</a><td> */<tr><td><a name="l206" href="#l206">206</a><td>goog.net.DefaultXmlHttpFactory.prototype.getProgId_ = function() {<tr><td><a name="l207" href="#l207">207</a><td> if (goog.net.XmlHttp.ASSUME_NATIVE_XHR ||<tr><td><a name="l208" href="#l208">208</a><td> goog.net.XmlHttpDefines.ASSUME_NATIVE_XHR) {<tr><td><a name="l209" href="#l209">209</a><td> return &#39;&#39;;<tr><td><a name="l210" href="#l210">210</a><td> }<tr><td><a name="l211" href="#l211">211</a><td><tr><td><a name="l212" href="#l212">212</a><td> // The following blog post describes what PROG IDs to use to create the<tr><td><a name="l213" href="#l213">213</a><td> // XMLHTTP object in Internet Explorer:<tr><td><a name="l214" href="#l214">214</a><td> // http://blogs.msdn.com/xmlteam/archive/2006/10/23/using-the-right-version-of-msxml-in-internet-explorer.aspx<tr><td><a name="l215" href="#l215">215</a><td> // However we do not (yet) fully trust that this will be OK for old versions<tr><td><a name="l216" href="#l216">216</a><td> // of IE on Win9x so we therefore keep the last 2.<tr><td><a name="l217" href="#l217">217</a><td> if (!this.ieProgId_ &amp;&amp; typeof XMLHttpRequest == &#39;undefined&#39; &amp;&amp;<tr><td><a name="l218" href="#l218">218</a><td> typeof ActiveXObject != &#39;undefined&#39;) {<tr><td><a name="l219" href="#l219">219</a><td> // Candidate Active X types.<tr><td><a name="l220" href="#l220">220</a><td> var ACTIVE_X_IDENTS = [&#39;MSXML2.XMLHTTP.6.0&#39;, &#39;MSXML2.XMLHTTP.3.0&#39;,<tr><td><a name="l221" href="#l221">221</a><td> &#39;MSXML2.XMLHTTP&#39;, &#39;Microsoft.XMLHTTP&#39;];<tr><td><a name="l222" href="#l222">222</a><td> for (var i = 0; i &lt; ACTIVE_X_IDENTS.length; i++) {<tr><td><a name="l223" href="#l223">223</a><td> var candidate = ACTIVE_X_IDENTS[i];<tr><td><a name="l224" href="#l224">224</a><td> /** @preserveTry */<tr><td><a name="l225" href="#l225">225</a><td> try {<tr><td><a name="l226" href="#l226">226</a><td> new ActiveXObject(candidate);<tr><td><a name="l227" href="#l227">227</a><td> // NOTE(user): cannot assign progid and return candidate in one line<tr><td><a name="l228" href="#l228">228</a><td> // because JSCompiler complaings: BUG 658126<tr><td><a name="l229" href="#l229">229</a><td> this.ieProgId_ = candidate;<tr><td><a name="l230" href="#l230">230</a><td> return candidate;<tr><td><a name="l231" href="#l231">231</a><td> } catch (e) {<tr><td><a name="l232" href="#l232">232</a><td> // do nothing; try next choice<tr><td><a name="l233" href="#l233">233</a><td> }<tr><td><a name="l234" href="#l234">234</a><td> }<tr><td><a name="l235" href="#l235">235</a><td><tr><td><a name="l236" href="#l236">236</a><td> // couldn&#39;t find any matches<tr><td><a name="l237" href="#l237">237</a><td> throw Error(&#39;Could not create ActiveXObject. ActiveX might be disabled,&#39; +<tr><td><a name="l238" href="#l238">238</a><td> &#39; or MSXML might not be installed&#39;);<tr><td><a name="l239" href="#l239">239</a><td> }<tr><td><a name="l240" href="#l240">240</a><td><tr><td><a name="l241" href="#l241">241</a><td> return /** @type {string} */ (this.ieProgId_);<tr><td><a name="l242" href="#l242">242</a><td>};<tr><td><a name="l243" href="#l243">243</a><td><tr><td><a name="l244" href="#l244">244</a><td><tr><td><a name="l245" href="#l245">245</a><td>//Set the global factory to an instance of the default factory.<tr><td><a name="l246" href="#l246">246</a><td>goog.net.XmlHttp.setGlobalFactory(new goog.net.DefaultXmlHttpFactory());</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>xmlhttp.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/net/xmlhttp.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2006 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Low level handling of XMLHttpRequest.<tr><td><a name="l17" href="#l17">17</a><td> * @author arv@google.com (Erik Arvidsson)<tr><td><a name="l18" href="#l18">18</a><td> * @author dbk@google.com (David Barrett-Kahn)<tr><td><a name="l19" href="#l19">19</a><td> */<tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;goog.net.DefaultXmlHttpFactory&#39;);<tr><td><a name="l22" href="#l22">22</a><td>goog.provide(&#39;goog.net.XmlHttp&#39;);<tr><td><a name="l23" href="#l23">23</a><td>goog.provide(&#39;goog.net.XmlHttp.OptionType&#39;);<tr><td><a name="l24" href="#l24">24</a><td>goog.provide(&#39;goog.net.XmlHttp.ReadyState&#39;);<tr><td><a name="l25" href="#l25">25</a><td>goog.provide(&#39;goog.net.XmlHttpDefines&#39;);<tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td>goog.require(&#39;goog.asserts&#39;);<tr><td><a name="l28" href="#l28">28</a><td>goog.require(&#39;goog.net.WrapperXmlHttpFactory&#39;);<tr><td><a name="l29" href="#l29">29</a><td>goog.require(&#39;goog.net.XmlHttpFactory&#39;);<tr><td><a name="l30" href="#l30">30</a><td><tr><td><a name="l31" href="#l31">31</a><td><tr><td><a name="l32" href="#l32">32</a><td>/**<tr><td><a name="l33" href="#l33">33</a><td> * Static class for creating XMLHttpRequest objects.<tr><td><a name="l34" href="#l34">34</a><td> * @return {!goog.net.XhrLike.OrNative} A new XMLHttpRequest object.<tr><td><a name="l35" href="#l35">35</a><td> */<tr><td><a name="l36" href="#l36">36</a><td>goog.net.XmlHttp = function() {<tr><td><a name="l37" href="#l37">37</a><td> return goog.net.XmlHttp.factory_.createInstance();<tr><td><a name="l38" href="#l38">38</a><td>};<tr><td><a name="l39" href="#l39">39</a><td><tr><td><a name="l40" href="#l40">40</a><td><tr><td><a name="l41" href="#l41">41</a><td>/**<tr><td><a name="l42" href="#l42">42</a><td> * @define {boolean} Whether to assume XMLHttpRequest exists. Setting this to<tr><td><a name="l43" href="#l43">43</a><td> * true bypasses the ActiveX probing code.<tr><td><a name="l44" href="#l44">44</a><td> * NOTE(user): Due to the way JSCompiler works, this define *will not* strip<tr><td><a name="l45" href="#l45">45</a><td> * out the ActiveX probing code from binaries. To achieve this, use<tr><td><a name="l46" href="#l46">46</a><td> * {@code goog.net.XmlHttpDefines.ASSUME_NATIVE_XHR} instead.<tr><td><a name="l47" href="#l47">47</a><td> * TODO(user): Collapse both defines.<tr><td><a name="l48" href="#l48">48</a><td> */<tr><td><a name="l49" href="#l49">49</a><td>goog.define(&#39;goog.net.XmlHttp.ASSUME_NATIVE_XHR&#39;, false);<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>/** @const */<tr><td><a name="l53" href="#l53">53</a><td>goog.net.XmlHttpDefines = {};<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> * @define {boolean} Whether to assume XMLHttpRequest exists. Setting this to<tr><td><a name="l58" href="#l58">58</a><td> * true eliminates the ActiveX probing code.<tr><td><a name="l59" href="#l59">59</a><td> */<tr><td><a name="l60" href="#l60">60</a><td>goog.define(&#39;goog.net.XmlHttpDefines.ASSUME_NATIVE_XHR&#39;, false);<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> * Gets the options to use with the XMLHttpRequest objects obtained using<tr><td><a name="l65" href="#l65">65</a><td> * the static methods.<tr><td><a name="l66" href="#l66">66</a><td> * @return {Object} The options.<tr><td><a name="l67" href="#l67">67</a><td> */<tr><td><a name="l68" href="#l68">68</a><td>goog.net.XmlHttp.getOptions = function() {<tr><td><a name="l69" href="#l69">69</a><td> return goog.net.XmlHttp.factory_.getOptions();<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>/**<tr><td><a name="l74" href="#l74">74</a><td> * Type of options that an XmlHttp object can have.<tr><td><a name="l75" href="#l75">75</a><td> * @enum {number}<tr><td><a name="l76" href="#l76">76</a><td> */<tr><td><a name="l77" href="#l77">77</a><td>goog.net.XmlHttp.OptionType = {<tr><td><a name="l78" href="#l78">78</a><td> /**<tr><td><a name="l79" href="#l79">79</a><td> * Whether a goog.nullFunction should be used to clear the onreadystatechange<tr><td><a name="l80" href="#l80">80</a><td> * handler instead of null.<tr><td><a name="l81" href="#l81">81</a><td> */<tr><td><a name="l82" href="#l82">82</a><td> USE_NULL_FUNCTION: 0,<tr><td><a name="l83" href="#l83">83</a><td><tr><td><a name="l84" href="#l84">84</a><td> /**<tr><td><a name="l85" href="#l85">85</a><td> * NOTE(user): In IE if send() errors on a *local* request the readystate<tr><td><a name="l86" href="#l86">86</a><td> * is still changed to COMPLETE. We need to ignore it and allow the<tr><td><a name="l87" href="#l87">87</a><td> * try/catch around send() to pick up the error.<tr><td><a name="l88" href="#l88">88</a><td> */<tr><td><a name="l89" href="#l89">89</a><td> LOCAL_REQUEST_ERROR: 1<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>/**<tr><td><a name="l94" href="#l94">94</a><td> * Status constants for XMLHTTP, matches:<tr><td><a name="l95" href="#l95">95</a><td> * http://msdn.microsoft.com/library/default.asp?url=/library/<tr><td><a name="l96" href="#l96">96</a><td> * en-us/xmlsdk/html/0e6a34e4-f90c-489d-acff-cb44242fafc6.asp<tr><td><a name="l97" href="#l97">97</a><td> * @enum {number}<tr><td><a name="l98" href="#l98">98</a><td> */<tr><td><a name="l99" href="#l99">99</a><td>goog.net.XmlHttp.ReadyState = {<tr><td><a name="l100" href="#l100">100</a><td> /**<tr><td><a name="l101" href="#l101">101</a><td> * Constant for when xmlhttprequest.readyState is uninitialized<tr><td><a name="l102" href="#l102">102</a><td> */<tr><td><a name="l103" href="#l103">103</a><td> UNINITIALIZED: 0,<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> * Constant for when xmlhttprequest.readyState is loading.<tr><td><a name="l107" href="#l107">107</a><td> */<tr><td><a name="l108" href="#l108">108</a><td> LOADING: 1,<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> * Constant for when xmlhttprequest.readyState is loaded.<tr><td><a name="l112" href="#l112">112</a><td> */<tr><td><a name="l113" href="#l113">113</a><td> LOADED: 2,<tr><td><a name="l114" href="#l114">114</a><td><tr><td><a name="l115" href="#l115">115</a><td> /**<tr><td><a name="l116" href="#l116">116</a><td> * Constant for when xmlhttprequest.readyState is in an interactive state.<tr><td><a name="l117" href="#l117">117</a><td> */<tr><td><a name="l118" href="#l118">118</a><td> INTERACTIVE: 3,<tr><td><a name="l119" href="#l119">119</a><td><tr><td><a name="l120" href="#l120">120</a><td> /**<tr><td><a name="l121" href="#l121">121</a><td> * Constant for when xmlhttprequest.readyState is completed<tr><td><a name="l122" href="#l122">122</a><td> */<tr><td><a name="l123" href="#l123">123</a><td> COMPLETE: 4<tr><td><a name="l124" href="#l124">124</a><td>};<tr><td><a name="l125" href="#l125">125</a><td><tr><td><a name="l126" href="#l126">126</a><td><tr><td><a name="l127" href="#l127">127</a><td>/**<tr><td><a name="l128" href="#l128">128</a><td> * The global factory instance for creating XMLHttpRequest objects.<tr><td><a name="l129" href="#l129">129</a><td> * @type {goog.net.XmlHttpFactory}<tr><td><a name="l130" href="#l130">130</a><td> * @private<tr><td><a name="l131" href="#l131">131</a><td> */<tr><td><a name="l132" href="#l132">132</a><td>goog.net.XmlHttp.factory_;<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> * Sets the factories for creating XMLHttpRequest objects and their options.<tr><td><a name="l137" href="#l137">137</a><td> * @param {Function} factory The factory for XMLHttpRequest objects.<tr><td><a name="l138" href="#l138">138</a><td> * @param {Function} optionsFactory The factory for options.<tr><td><a name="l139" href="#l139">139</a><td> * @deprecated Use setGlobalFactory instead.<tr><td><a name="l140" href="#l140">140</a><td> */<tr><td><a name="l141" href="#l141">141</a><td>goog.net.XmlHttp.setFactory = function(factory, optionsFactory) {<tr><td><a name="l142" href="#l142">142</a><td> goog.net.XmlHttp.setGlobalFactory(new goog.net.WrapperXmlHttpFactory(<tr><td><a name="l143" href="#l143">143</a><td> goog.asserts.assert(factory),<tr><td><a name="l144" href="#l144">144</a><td> goog.asserts.assert(optionsFactory)));<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> * Sets the global factory object.<tr><td><a name="l150" href="#l150">150</a><td> * @param {!goog.net.XmlHttpFactory} factory New global factory object.<tr><td><a name="l151" href="#l151">151</a><td> */<tr><td><a name="l152" href="#l152">152</a><td>goog.net.XmlHttp.setGlobalFactory = function(factory) {<tr><td><a name="l153" href="#l153">153</a><td> goog.net.XmlHttp.factory_ = factory;<tr><td><a name="l154" href="#l154">154</a><td>};<tr><td><a name="l155" href="#l155">155</a><td><tr><td><a name="l156" href="#l156">156</a><td><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> * Default factory to use when creating xhr objects. You probably shouldn&#39;t be<tr><td><a name="l160" href="#l160">160</a><td> * instantiating this directly, but rather using it via goog.net.XmlHttp.<tr><td><a name="l161" href="#l161">161</a><td> * @extends {goog.net.XmlHttpFactory}<tr><td><a name="l162" href="#l162">162</a><td> * @constructor<tr><td><a name="l163" href="#l163">163</a><td> */<tr><td><a name="l164" href="#l164">164</a><td>goog.net.DefaultXmlHttpFactory = function() {<tr><td><a name="l165" href="#l165">165</a><td> goog.net.XmlHttpFactory.call(this);<tr><td><a name="l166" href="#l166">166</a><td>};<tr><td><a name="l167" href="#l167">167</a><td>goog.inherits(goog.net.DefaultXmlHttpFactory, goog.net.XmlHttpFactory);<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>/** @override */<tr><td><a name="l171" href="#l171">171</a><td>goog.net.DefaultXmlHttpFactory.prototype.createInstance = function() {<tr><td><a name="l172" href="#l172">172</a><td> var progId = this.getProgId_();<tr><td><a name="l173" href="#l173">173</a><td> if (progId) {<tr><td><a name="l174" href="#l174">174</a><td> return new ActiveXObject(progId);<tr><td><a name="l175" href="#l175">175</a><td> } else {<tr><td><a name="l176" href="#l176">176</a><td> return new XMLHttpRequest();<tr><td><a name="l177" href="#l177">177</a><td> }<tr><td><a name="l178" href="#l178">178</a><td>};<tr><td><a name="l179" href="#l179">179</a><td><tr><td><a name="l180" href="#l180">180</a><td><tr><td><a name="l181" href="#l181">181</a><td>/** @override */<tr><td><a name="l182" href="#l182">182</a><td>goog.net.DefaultXmlHttpFactory.prototype.internalGetOptions = function() {<tr><td><a name="l183" href="#l183">183</a><td> var progId = this.getProgId_();<tr><td><a name="l184" href="#l184">184</a><td> var options = {};<tr><td><a name="l185" href="#l185">185</a><td> if (progId) {<tr><td><a name="l186" href="#l186">186</a><td> options[goog.net.XmlHttp.OptionType.USE_NULL_FUNCTION] = true;<tr><td><a name="l187" href="#l187">187</a><td> options[goog.net.XmlHttp.OptionType.LOCAL_REQUEST_ERROR] = true;<tr><td><a name="l188" href="#l188">188</a><td> }<tr><td><a name="l189" href="#l189">189</a><td> return options;<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>/**<tr><td><a name="l194" href="#l194">194</a><td> * The ActiveX PROG ID string to use to create xhr&#39;s in IE. Lazily initialized.<tr><td><a name="l195" href="#l195">195</a><td> * @type {string|undefined}<tr><td><a name="l196" href="#l196">196</a><td> * @private<tr><td><a name="l197" href="#l197">197</a><td> */<tr><td><a name="l198" href="#l198">198</a><td>goog.net.DefaultXmlHttpFactory.prototype.ieProgId_;<tr><td><a name="l199" href="#l199">199</a><td><tr><td><a name="l200" href="#l200">200</a><td><tr><td><a name="l201" href="#l201">201</a><td>/**<tr><td><a name="l202" href="#l202">202</a><td> * Initialize the private state used by other functions.<tr><td><a name="l203" href="#l203">203</a><td> * @return {string} The ActiveX PROG ID string to use to create xhr&#39;s in IE.<tr><td><a name="l204" href="#l204">204</a><td> * @private<tr><td><a name="l205" href="#l205">205</a><td> */<tr><td><a name="l206" href="#l206">206</a><td>goog.net.DefaultXmlHttpFactory.prototype.getProgId_ = function() {<tr><td><a name="l207" href="#l207">207</a><td> if (goog.net.XmlHttp.ASSUME_NATIVE_XHR ||<tr><td><a name="l208" href="#l208">208</a><td> goog.net.XmlHttpDefines.ASSUME_NATIVE_XHR) {<tr><td><a name="l209" href="#l209">209</a><td> return &#39;&#39;;<tr><td><a name="l210" href="#l210">210</a><td> }<tr><td><a name="l211" href="#l211">211</a><td><tr><td><a name="l212" href="#l212">212</a><td> // The following blog post describes what PROG IDs to use to create the<tr><td><a name="l213" href="#l213">213</a><td> // XMLHTTP object in Internet Explorer:<tr><td><a name="l214" href="#l214">214</a><td> // http://blogs.msdn.com/xmlteam/archive/2006/10/23/using-the-right-version-of-msxml-in-internet-explorer.aspx<tr><td><a name="l215" href="#l215">215</a><td> // However we do not (yet) fully trust that this will be OK for old versions<tr><td><a name="l216" href="#l216">216</a><td> // of IE on Win9x so we therefore keep the last 2.<tr><td><a name="l217" href="#l217">217</a><td> if (!this.ieProgId_ &amp;&amp; typeof XMLHttpRequest == &#39;undefined&#39; &amp;&amp;<tr><td><a name="l218" href="#l218">218</a><td> typeof ActiveXObject != &#39;undefined&#39;) {<tr><td><a name="l219" href="#l219">219</a><td> // Candidate Active X types.<tr><td><a name="l220" href="#l220">220</a><td> var ACTIVE_X_IDENTS = [&#39;MSXML2.XMLHTTP.6.0&#39;, &#39;MSXML2.XMLHTTP.3.0&#39;,<tr><td><a name="l221" href="#l221">221</a><td> &#39;MSXML2.XMLHTTP&#39;, &#39;Microsoft.XMLHTTP&#39;];<tr><td><a name="l222" href="#l222">222</a><td> for (var i = 0; i &lt; ACTIVE_X_IDENTS.length; i++) {<tr><td><a name="l223" href="#l223">223</a><td> var candidate = ACTIVE_X_IDENTS[i];<tr><td><a name="l224" href="#l224">224</a><td> /** @preserveTry */<tr><td><a name="l225" href="#l225">225</a><td> try {<tr><td><a name="l226" href="#l226">226</a><td> new ActiveXObject(candidate);<tr><td><a name="l227" href="#l227">227</a><td> // NOTE(user): cannot assign progid and return candidate in one line<tr><td><a name="l228" href="#l228">228</a><td> // because JSCompiler complaings: BUG 658126<tr><td><a name="l229" href="#l229">229</a><td> this.ieProgId_ = candidate;<tr><td><a name="l230" href="#l230">230</a><td> return candidate;<tr><td><a name="l231" href="#l231">231</a><td> } catch (e) {<tr><td><a name="l232" href="#l232">232</a><td> // do nothing; try next choice<tr><td><a name="l233" href="#l233">233</a><td> }<tr><td><a name="l234" href="#l234">234</a><td> }<tr><td><a name="l235" href="#l235">235</a><td><tr><td><a name="l236" href="#l236">236</a><td> // couldn&#39;t find any matches<tr><td><a name="l237" href="#l237">237</a><td> throw Error(&#39;Could not create ActiveXObject. ActiveX might be disabled,&#39; +<tr><td><a name="l238" href="#l238">238</a><td> &#39; or MSXML might not be installed&#39;);<tr><td><a name="l239" href="#l239">239</a><td> }<tr><td><a name="l240" href="#l240">240</a><td><tr><td><a name="l241" href="#l241">241</a><td> return /** @type {string} */ (this.ieProgId_);<tr><td><a name="l242" href="#l242">242</a><td>};<tr><td><a name="l243" href="#l243">243</a><td><tr><td><a name="l244" href="#l244">244</a><td><tr><td><a name="l245" href="#l245">245</a><td>//Set the global factory to an instance of the default factory.<tr><td><a name="l246" href="#l246">246</a><td>goog.net.XmlHttp.setGlobalFactory(new goog.net.DefaultXmlHttpFactory());</table></pre></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="../../../../license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="../../../../types.js"></script><script src="../../../../dossier.js"></script>
package/docs/source/lib/goog/net/xmlhttpfactory.js.src.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>xmlhttpfactory.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/net/xmlhttpfactory.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2010 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Interface for a factory for creating XMLHttpRequest objects<tr><td><a name="l17" href="#l17">17</a><td> * and metadata about them.<tr><td><a name="l18" href="#l18">18</a><td> * @author dbk@google.com (David Barrett-Kahn)<tr><td><a name="l19" href="#l19">19</a><td> */<tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;goog.net.XmlHttpFactory&#39;);<tr><td><a name="l22" href="#l22">22</a><td><tr><td><a name="l23" href="#l23">23</a><td>/** @suppress {extraRequire} Typedef. */<tr><td><a name="l24" href="#l24">24</a><td>goog.require(&#39;goog.net.XhrLike&#39;);<tr><td><a name="l25" href="#l25">25</a><td><tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td><tr><td><a name="l28" href="#l28">28</a><td>/**<tr><td><a name="l29" href="#l29">29</a><td> * Abstract base class for an XmlHttpRequest factory.<tr><td><a name="l30" href="#l30">30</a><td> * @constructor<tr><td><a name="l31" href="#l31">31</a><td> */<tr><td><a name="l32" href="#l32">32</a><td>goog.net.XmlHttpFactory = function() {<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> * Cache of options - we only actually call internalGetOptions once.<tr><td><a name="l38" href="#l38">38</a><td> * @type {Object}<tr><td><a name="l39" href="#l39">39</a><td> * @private<tr><td><a name="l40" href="#l40">40</a><td> */<tr><td><a name="l41" href="#l41">41</a><td>goog.net.XmlHttpFactory.prototype.cachedOptions_ = null;<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> * @return {!goog.net.XhrLike.OrNative} A new XhrLike instance.<tr><td><a name="l46" href="#l46">46</a><td> */<tr><td><a name="l47" href="#l47">47</a><td>goog.net.XmlHttpFactory.prototype.createInstance = goog.abstractMethod;<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> * @return {Object} Options describing how xhr objects obtained from this<tr><td><a name="l52" href="#l52">52</a><td> * factory should be used.<tr><td><a name="l53" href="#l53">53</a><td> */<tr><td><a name="l54" href="#l54">54</a><td>goog.net.XmlHttpFactory.prototype.getOptions = function() {<tr><td><a name="l55" href="#l55">55</a><td> return this.cachedOptions_ ||<tr><td><a name="l56" href="#l56">56</a><td> (this.cachedOptions_ = this.internalGetOptions());<tr><td><a name="l57" href="#l57">57</a><td>};<tr><td><a name="l58" href="#l58">58</a><td><tr><td><a name="l59" href="#l59">59</a><td><tr><td><a name="l60" href="#l60">60</a><td>/**<tr><td><a name="l61" href="#l61">61</a><td> * Override this method in subclasses to preserve the caching offered by<tr><td><a name="l62" href="#l62">62</a><td> * getOptions().<tr><td><a name="l63" href="#l63">63</a><td> * @return {Object} Options describing how xhr objects obtained from this<tr><td><a name="l64" href="#l64">64</a><td> * factory should be used.<tr><td><a name="l65" href="#l65">65</a><td> * @protected<tr><td><a name="l66" href="#l66">66</a><td> */<tr><td><a name="l67" href="#l67">67</a><td>goog.net.XmlHttpFactory.prototype.internalGetOptions = goog.abstractMethod;</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>xmlhttpfactory.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>lib/goog/net/xmlhttpfactory.js</h1></header><pre><table class="srcfile"><tbody><tr><td><a name="l1" href="#l1">1</a><td>// Copyright 2010 The Closure Library Authors. All Rights Reserved.<tr><td><a name="l2" href="#l2">2</a><td>//<tr><td><a name="l3" href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<tr><td><a name="l4" href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a name="l5" href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a name="l6" href="#l6">6</a><td>//<tr><td><a name="l7" href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a name="l8" href="#l8">8</a><td>//<tr><td><a name="l9" href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a name="l10" href="#l10">10</a><td>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,<tr><td><a name="l11" href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a name="l12" href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a name="l13" href="#l13">13</a><td>// limitations under the License.<tr><td><a name="l14" href="#l14">14</a><td><tr><td><a name="l15" href="#l15">15</a><td>/**<tr><td><a name="l16" href="#l16">16</a><td> * @fileoverview Interface for a factory for creating XMLHttpRequest objects<tr><td><a name="l17" href="#l17">17</a><td> * and metadata about them.<tr><td><a name="l18" href="#l18">18</a><td> * @author dbk@google.com (David Barrett-Kahn)<tr><td><a name="l19" href="#l19">19</a><td> */<tr><td><a name="l20" href="#l20">20</a><td><tr><td><a name="l21" href="#l21">21</a><td>goog.provide(&#39;goog.net.XmlHttpFactory&#39;);<tr><td><a name="l22" href="#l22">22</a><td><tr><td><a name="l23" href="#l23">23</a><td>/** @suppress {extraRequire} Typedef. */<tr><td><a name="l24" href="#l24">24</a><td>goog.require(&#39;goog.net.XhrLike&#39;);<tr><td><a name="l25" href="#l25">25</a><td><tr><td><a name="l26" href="#l26">26</a><td><tr><td><a name="l27" href="#l27">27</a><td><tr><td><a name="l28" href="#l28">28</a><td>/**<tr><td><a name="l29" href="#l29">29</a><td> * Abstract base class for an XmlHttpRequest factory.<tr><td><a name="l30" href="#l30">30</a><td> * @constructor<tr><td><a name="l31" href="#l31">31</a><td> */<tr><td><a name="l32" href="#l32">32</a><td>goog.net.XmlHttpFactory = function() {<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> * Cache of options - we only actually call internalGetOptions once.<tr><td><a name="l38" href="#l38">38</a><td> * @type {Object}<tr><td><a name="l39" href="#l39">39</a><td> * @private<tr><td><a name="l40" href="#l40">40</a><td> */<tr><td><a name="l41" href="#l41">41</a><td>goog.net.XmlHttpFactory.prototype.cachedOptions_ = null;<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> * @return {!goog.net.XhrLike.OrNative} A new XhrLike instance.<tr><td><a name="l46" href="#l46">46</a><td> */<tr><td><a name="l47" href="#l47">47</a><td>goog.net.XmlHttpFactory.prototype.createInstance = goog.abstractMethod;<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> * @return {Object} Options describing how xhr objects obtained from this<tr><td><a name="l52" href="#l52">52</a><td> * factory should be used.<tr><td><a name="l53" href="#l53">53</a><td> */<tr><td><a name="l54" href="#l54">54</a><td>goog.net.XmlHttpFactory.prototype.getOptions = function() {<tr><td><a name="l55" href="#l55">55</a><td> return this.cachedOptions_ ||<tr><td><a name="l56" href="#l56">56</a><td> (this.cachedOptions_ = this.internalGetOptions());<tr><td><a name="l57" href="#l57">57</a><td>};<tr><td><a name="l58" href="#l58">58</a><td><tr><td><a name="l59" href="#l59">59</a><td><tr><td><a name="l60" href="#l60">60</a><td>/**<tr><td><a name="l61" href="#l61">61</a><td> * Override this method in subclasses to preserve the caching offered by<tr><td><a name="l62" href="#l62">62</a><td> * getOptions().<tr><td><a name="l63" href="#l63">63</a><td> * @return {Object} Options describing how xhr objects obtained from this<tr><td><a name="l64" href="#l64">64</a><td> * factory should be used.<tr><td><a name="l65" href="#l65">65</a><td> * @protected<tr><td><a name="l66" href="#l66">66</a><td> */<tr><td><a name="l67" href="#l67">67</a><td>goog.net.XmlHttpFactory.prototype.internalGetOptions = goog.abstractMethod;</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>