selenium-webdriver

Version:

The official WebDriver JavaScript bindings from the Selenium project

1 lines • 21.5 kB

HTML

<!DOCTYPE html><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>touchsequence.js</title><link href="../../../dossier.css" rel="stylesheet" type="text/css"><header><div><form><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></header><main><article class="srcfile"><h1>lib/webdriver/touchsequence.js</h1><div><table><tr><td><a id="l1"></a><a href="#l1">1</a><td>// Licensed to the Software Freedom Conservancy (SFC) under one<tr><td><a id="l2"></a><a href="#l2">2</a><td>// or more contributor license agreements. See the NOTICE file<tr><td><a id="l3"></a><a href="#l3">3</a><td>// distributed with this work for additional information<tr><td><a id="l4"></a><a href="#l4">4</a><td>// regarding copyright ownership. The SFC licenses this file<tr><td><a id="l5"></a><a href="#l5">5</a><td>// to you under the Apache License, Version 2.0 (the<tr><td><a id="l6"></a><a href="#l6">6</a><td>// "License"); you may not use this file except in compliance<tr><td><a id="l7"></a><a href="#l7">7</a><td>// with the License. You may obtain a copy of the License at<tr><td><a id="l8"></a><a href="#l8">8</a><td>//<tr><td><a id="l9"></a><a href="#l9">9</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a id="l10"></a><a href="#l10">10</a><td>//<tr><td><a id="l11"></a><a href="#l11">11</a><td>// Unless required by applicable law or agreed to in writing,<tr><td><a id="l12"></a><a href="#l12">12</a><td>// software distributed under the License is distributed on an<tr><td><a id="l13"></a><a href="#l13">13</a><td>// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<tr><td><a id="l14"></a><a href="#l14">14</a><td>// KIND, either express or implied. See the License for the<tr><td><a id="l15"></a><a href="#l15">15</a><td>// specific language governing permissions and limitations<tr><td><a id="l16"></a><a href="#l16">16</a><td>// under the License.<tr><td><a id="l17"></a><a href="#l17">17</a><td><tr><td><a id="l18"></a><a href="#l18">18</a><td>goog.provide('webdriver.TouchSequence');<tr><td><a id="l19"></a><a href="#l19">19</a><td><tr><td><a id="l20"></a><a href="#l20">20</a><td>goog.require('goog.array');<tr><td><a id="l21"></a><a href="#l21">21</a><td>goog.require('webdriver.Command');<tr><td><a id="l22"></a><a href="#l22">22</a><td>goog.require('webdriver.CommandName');<tr><td><a id="l23"></a><a href="#l23">23</a><td><tr><td><a id="l24"></a><a href="#l24">24</a><td><tr><td><a id="l25"></a><a href="#l25">25</a><td><tr><td><a id="l26"></a><a href="#l26">26</a><td>/**<tr><td><a id="l27"></a><a href="#l27">27</a><td> * Class for defining sequences of user touch interactions. Each sequence<tr><td><a id="l28"></a><a href="#l28">28</a><td> * will not be executed until {@link #perform} is called.<tr><td><a id="l29"></a><a href="#l29">29</a><td> *<tr><td><a id="l30"></a><a href="#l30">30</a><td> * Example:<tr><td><a id="l31"></a><a href="#l31">31</a><td> *<tr><td><a id="l32"></a><a href="#l32">32</a><td> * new webdriver.TouchSequence(driver).<tr><td><a id="l33"></a><a href="#l33">33</a><td> * tapAndHold({x: 0, y: 0}).<tr><td><a id="l34"></a><a href="#l34">34</a><td> * move({x: 3, y: 4}).<tr><td><a id="l35"></a><a href="#l35">35</a><td> * release({x: 10, y: 10}).<tr><td><a id="l36"></a><a href="#l36">36</a><td> * perform();<tr><td><a id="l37"></a><a href="#l37">37</a><td> *<tr><td><a id="l38"></a><a href="#l38">38</a><td> * @param {!webdriver.WebDriver} driver The driver instance to use.<tr><td><a id="l39"></a><a href="#l39">39</a><td> * @constructor<tr><td><a id="l40"></a><a href="#l40">40</a><td> */<tr><td><a id="l41"></a><a href="#l41">41</a><td>webdriver.TouchSequence = function(driver) {<tr><td><a id="l42"></a><a href="#l42">42</a><td><tr><td><a id="l43"></a><a href="#l43">43</a><td> /** @private {!webdriver.WebDriver} */<tr><td><a id="l44"></a><a href="#l44">44</a><td> this.driver_ = driver;<tr><td><a id="l45"></a><a href="#l45">45</a><td><tr><td><a id="l46"></a><a href="#l46">46</a><td> /** @private {!Array<{description: string, command: !webdriver.Command}>} */<tr><td><a id="l47"></a><a href="#l47">47</a><td> this.touchActions_ = [];<tr><td><a id="l48"></a><a href="#l48">48</a><td>};<tr><td><a id="l49"></a><a href="#l49">49</a><td><tr><td><a id="l50"></a><a href="#l50">50</a><td><tr><td><a id="l51"></a><a href="#l51">51</a><td>/**<tr><td><a id="l52"></a><a href="#l52">52</a><td> * Schedules an action to be executed each time {@link #perform} is called on<tr><td><a id="l53"></a><a href="#l53">53</a><td> * this instance.<tr><td><a id="l54"></a><a href="#l54">54</a><td> * @param {string} description A description of the command.<tr><td><a id="l55"></a><a href="#l55">55</a><td> * @param {!webdriver.Command} command The command.<tr><td><a id="l56"></a><a href="#l56">56</a><td> * @private<tr><td><a id="l57"></a><a href="#l57">57</a><td> */<tr><td><a id="l58"></a><a href="#l58">58</a><td>webdriver.TouchSequence.prototype.schedule_ = function(description, command) {<tr><td><a id="l59"></a><a href="#l59">59</a><td> this.touchActions_.push({<tr><td><a id="l60"></a><a href="#l60">60</a><td> description: description,<tr><td><a id="l61"></a><a href="#l61">61</a><td> command: command<tr><td><a id="l62"></a><a href="#l62">62</a><td> });<tr><td><a id="l63"></a><a href="#l63">63</a><td>};<tr><td><a id="l64"></a><a href="#l64">64</a><td><tr><td><a id="l65"></a><a href="#l65">65</a><td><tr><td><a id="l66"></a><a href="#l66">66</a><td>/**<tr><td><a id="l67"></a><a href="#l67">67</a><td> * Executes this action sequence.<tr><td><a id="l68"></a><a href="#l68">68</a><td> * @return {!webdriver.promise.Promise} A promise that will be resolved once<tr><td><a id="l69"></a><a href="#l69">69</a><td> * this sequence has completed.<tr><td><a id="l70"></a><a href="#l70">70</a><td> */<tr><td><a id="l71"></a><a href="#l71">71</a><td>webdriver.TouchSequence.prototype.perform = function() {<tr><td><a id="l72"></a><a href="#l72">72</a><td> // Make a protected copy of the scheduled actions. This will protect against<tr><td><a id="l73"></a><a href="#l73">73</a><td> // users defining additional commands before this sequence is actually<tr><td><a id="l74"></a><a href="#l74">74</a><td> // executed.<tr><td><a id="l75"></a><a href="#l75">75</a><td> var actions = goog.array.clone(this.touchActions_);<tr><td><a id="l76"></a><a href="#l76">76</a><td> var driver = this.driver_;<tr><td><a id="l77"></a><a href="#l77">77</a><td> return driver.controlFlow().execute(function() {<tr><td><a id="l78"></a><a href="#l78">78</a><td> goog.array.forEach(actions, function(action) {<tr><td><a id="l79"></a><a href="#l79">79</a><td> driver.schedule(action.command, action.description);<tr><td><a id="l80"></a><a href="#l80">80</a><td> });<tr><td><a id="l81"></a><a href="#l81">81</a><td> }, 'TouchSequence.perform');<tr><td><a id="l82"></a><a href="#l82">82</a><td>};<tr><td><a id="l83"></a><a href="#l83">83</a><td><tr><td><a id="l84"></a><a href="#l84">84</a><td><tr><td><a id="l85"></a><a href="#l85">85</a><td>/**<tr><td><a id="l86"></a><a href="#l86">86</a><td> * Taps an element.<tr><td><a id="l87"></a><a href="#l87">87</a><td> *<tr><td><a id="l88"></a><a href="#l88">88</a><td> * @param {!webdriver.WebElement} elem The element to tap.<tr><td><a id="l89"></a><a href="#l89">89</a><td> * @return {!webdriver.TouchSequence} A self reference.<tr><td><a id="l90"></a><a href="#l90">90</a><td> */<tr><td><a id="l91"></a><a href="#l91">91</a><td>webdriver.TouchSequence.prototype.tap = function(elem) {<tr><td><a id="l92"></a><a href="#l92">92</a><td> var command = new webdriver.Command(webdriver.CommandName.TOUCH_SINGLE_TAP).<tr><td><a id="l93"></a><a href="#l93">93</a><td> setParameter('element', elem.getRawId());<tr><td><a id="l94"></a><a href="#l94">94</a><td><tr><td><a id="l95"></a><a href="#l95">95</a><td> this.schedule_('tap', command);<tr><td><a id="l96"></a><a href="#l96">96</a><td> return this;<tr><td><a id="l97"></a><a href="#l97">97</a><td>};<tr><td><a id="l98"></a><a href="#l98">98</a><td><tr><td><a id="l99"></a><a href="#l99">99</a><td><tr><td><a id="l100"></a><a href="#l100">100</a><td>/**<tr><td><a id="l101"></a><a href="#l101">101</a><td> * Double taps an element.<tr><td><a id="l102"></a><a href="#l102">102</a><td> *<tr><td><a id="l103"></a><a href="#l103">103</a><td> * @param {!webdriver.WebElement} elem The element to double tap.<tr><td><a id="l104"></a><a href="#l104">104</a><td> * @return {!webdriver.TouchSequence} A self reference.<tr><td><a id="l105"></a><a href="#l105">105</a><td> */<tr><td><a id="l106"></a><a href="#l106">106</a><td>webdriver.TouchSequence.prototype.doubleTap = function(elem) {<tr><td><a id="l107"></a><a href="#l107">107</a><td> var command = new webdriver.Command(webdriver.CommandName.TOUCH_DOUBLE_TAP).<tr><td><a id="l108"></a><a href="#l108">108</a><td> setParameter('element', elem.getRawId());<tr><td><a id="l109"></a><a href="#l109">109</a><td><tr><td><a id="l110"></a><a href="#l110">110</a><td> this.schedule_('doubleTap', command);<tr><td><a id="l111"></a><a href="#l111">111</a><td> return this;<tr><td><a id="l112"></a><a href="#l112">112</a><td>};<tr><td><a id="l113"></a><a href="#l113">113</a><td><tr><td><a id="l114"></a><a href="#l114">114</a><td><tr><td><a id="l115"></a><a href="#l115">115</a><td>/**<tr><td><a id="l116"></a><a href="#l116">116</a><td> * Long press on an element.<tr><td><a id="l117"></a><a href="#l117">117</a><td> *<tr><td><a id="l118"></a><a href="#l118">118</a><td> * @param {!webdriver.WebElement} elem The element to long press.<tr><td><a id="l119"></a><a href="#l119">119</a><td> * @return {!webdriver.TouchSequence} A self reference.<tr><td><a id="l120"></a><a href="#l120">120</a><td> */<tr><td><a id="l121"></a><a href="#l121">121</a><td>webdriver.TouchSequence.prototype.longPress = function(elem) {<tr><td><a id="l122"></a><a href="#l122">122</a><td> var command = new webdriver.Command(webdriver.CommandName.TOUCH_LONG_PRESS).<tr><td><a id="l123"></a><a href="#l123">123</a><td> setParameter('element', elem.getRawId());<tr><td><a id="l124"></a><a href="#l124">124</a><td><tr><td><a id="l125"></a><a href="#l125">125</a><td> this.schedule_('longPress', command);<tr><td><a id="l126"></a><a href="#l126">126</a><td> return this;<tr><td><a id="l127"></a><a href="#l127">127</a><td>};<tr><td><a id="l128"></a><a href="#l128">128</a><td><tr><td><a id="l129"></a><a href="#l129">129</a><td><tr><td><a id="l130"></a><a href="#l130">130</a><td>/**<tr><td><a id="l131"></a><a href="#l131">131</a><td> * Touch down at the given location.<tr><td><a id="l132"></a><a href="#l132">132</a><td> *<tr><td><a id="l133"></a><a href="#l133">133</a><td> * @param {{x: number, y: number}} location The location to touch down at.<tr><td><a id="l134"></a><a href="#l134">134</a><td> * @return {!webdriver.TouchSequence} A self reference.<tr><td><a id="l135"></a><a href="#l135">135</a><td> */<tr><td><a id="l136"></a><a href="#l136">136</a><td>webdriver.TouchSequence.prototype.tapAndHold = function(location) {<tr><td><a id="l137"></a><a href="#l137">137</a><td> var command = new webdriver.Command(webdriver.CommandName.TOUCH_DOWN).<tr><td><a id="l138"></a><a href="#l138">138</a><td> setParameter('x', location.x).<tr><td><a id="l139"></a><a href="#l139">139</a><td> setParameter('y', location.y);<tr><td><a id="l140"></a><a href="#l140">140</a><td><tr><td><a id="l141"></a><a href="#l141">141</a><td> this.schedule_('tapAndHold', command);<tr><td><a id="l142"></a><a href="#l142">142</a><td> return this;<tr><td><a id="l143"></a><a href="#l143">143</a><td>};<tr><td><a id="l144"></a><a href="#l144">144</a><td><tr><td><a id="l145"></a><a href="#l145">145</a><td><tr><td><a id="l146"></a><a href="#l146">146</a><td>/**<tr><td><a id="l147"></a><a href="#l147">147</a><td> * Move a held {@linkplain #tapAndHold touch} to the specified location.<tr><td><a id="l148"></a><a href="#l148">148</a><td> *<tr><td><a id="l149"></a><a href="#l149">149</a><td> * @param {{x: number, y: number}} location The location to move to.<tr><td><a id="l150"></a><a href="#l150">150</a><td> * @return {!webdriver.TouchSequence} A self reference.<tr><td><a id="l151"></a><a href="#l151">151</a><td> */<tr><td><a id="l152"></a><a href="#l152">152</a><td>webdriver.TouchSequence.prototype.move = function(location) {<tr><td><a id="l153"></a><a href="#l153">153</a><td> var command = new webdriver.Command(webdriver.CommandName.TOUCH_MOVE).<tr><td><a id="l154"></a><a href="#l154">154</a><td> setParameter('x', location.x).<tr><td><a id="l155"></a><a href="#l155">155</a><td> setParameter('y', location.y);<tr><td><a id="l156"></a><a href="#l156">156</a><td><tr><td><a id="l157"></a><a href="#l157">157</a><td> this.schedule_('move', command);<tr><td><a id="l158"></a><a href="#l158">158</a><td> return this;<tr><td><a id="l159"></a><a href="#l159">159</a><td>};<tr><td><a id="l160"></a><a href="#l160">160</a><td><tr><td><a id="l161"></a><a href="#l161">161</a><td><tr><td><a id="l162"></a><a href="#l162">162</a><td>/**<tr><td><a id="l163"></a><a href="#l163">163</a><td> * Release a held {@linkplain #tapAndHold touch} at the specified location.<tr><td><a id="l164"></a><a href="#l164">164</a><td> *<tr><td><a id="l165"></a><a href="#l165">165</a><td> * @param {{x: number, y: number}} location The location to release at.<tr><td><a id="l166"></a><a href="#l166">166</a><td> * @return {!webdriver.TouchSequence} A self reference.<tr><td><a id="l167"></a><a href="#l167">167</a><td> */<tr><td><a id="l168"></a><a href="#l168">168</a><td>webdriver.TouchSequence.prototype.release = function(location) {<tr><td><a id="l169"></a><a href="#l169">169</a><td> var command = new webdriver.Command(webdriver.CommandName.TOUCH_UP).<tr><td><a id="l170"></a><a href="#l170">170</a><td> setParameter('x', location.x).<tr><td><a id="l171"></a><a href="#l171">171</a><td> setParameter('y', location.y);<tr><td><a id="l172"></a><a href="#l172">172</a><td><tr><td><a id="l173"></a><a href="#l173">173</a><td> this.schedule_('release', command);<tr><td><a id="l174"></a><a href="#l174">174</a><td> return this;<tr><td><a id="l175"></a><a href="#l175">175</a><td>};<tr><td><a id="l176"></a><a href="#l176">176</a><td><tr><td><a id="l177"></a><a href="#l177">177</a><td><tr><td><a id="l178"></a><a href="#l178">178</a><td>/**<tr><td><a id="l179"></a><a href="#l179">179</a><td> * Scrolls the touch screen by the given offset.<tr><td><a id="l180"></a><a href="#l180">180</a><td> *<tr><td><a id="l181"></a><a href="#l181">181</a><td> * @param {{x: number, y: number}} offset The offset to scroll to.<tr><td><a id="l182"></a><a href="#l182">182</a><td> * @return {!webdriver.TouchSequence} A self reference.<tr><td><a id="l183"></a><a href="#l183">183</a><td> */<tr><td><a id="l184"></a><a href="#l184">184</a><td>webdriver.TouchSequence.prototype.scroll = function(offset) {<tr><td><a id="l185"></a><a href="#l185">185</a><td> var command = new webdriver.Command(webdriver.CommandName.TOUCH_SCROLL).<tr><td><a id="l186"></a><a href="#l186">186</a><td> setParameter('xoffset', offset.x).<tr><td><a id="l187"></a><a href="#l187">187</a><td> setParameter('yoffset', offset.y);<tr><td><a id="l188"></a><a href="#l188">188</a><td><tr><td><a id="l189"></a><a href="#l189">189</a><td> this.schedule_('scroll', command);<tr><td><a id="l190"></a><a href="#l190">190</a><td> return this;<tr><td><a id="l191"></a><a href="#l191">191</a><td>};<tr><td><a id="l192"></a><a href="#l192">192</a><td><tr><td><a id="l193"></a><a href="#l193">193</a><td><tr><td><a id="l194"></a><a href="#l194">194</a><td>/**<tr><td><a id="l195"></a><a href="#l195">195</a><td> * Scrolls the touch screen, starting on `elem` and moving by the specified<tr><td><a id="l196"></a><a href="#l196">196</a><td> * offset.<tr><td><a id="l197"></a><a href="#l197">197</a><td> *<tr><td><a id="l198"></a><a href="#l198">198</a><td> * @param {!webdriver.WebElement} elem The element where scroll starts.<tr><td><a id="l199"></a><a href="#l199">199</a><td> * @param {{x: number, y: number}} offset The offset to scroll to.<tr><td><a id="l200"></a><a href="#l200">200</a><td> * @return {!webdriver.TouchSequence} A self reference.<tr><td><a id="l201"></a><a href="#l201">201</a><td> */<tr><td><a id="l202"></a><a href="#l202">202</a><td>webdriver.TouchSequence.prototype.scrollFromElement = function(elem, offset) {<tr><td><a id="l203"></a><a href="#l203">203</a><td> var command = new webdriver.Command(webdriver.CommandName.TOUCH_SCROLL).<tr><td><a id="l204"></a><a href="#l204">204</a><td> setParameter('element', elem.getRawId()).<tr><td><a id="l205"></a><a href="#l205">205</a><td> setParameter('xoffset', offset.x).<tr><td><a id="l206"></a><a href="#l206">206</a><td> setParameter('yoffset', offset.y);<tr><td><a id="l207"></a><a href="#l207">207</a><td><tr><td><a id="l208"></a><a href="#l208">208</a><td> this.schedule_('scrollFromElement', command);<tr><td><a id="l209"></a><a href="#l209">209</a><td> return this;<tr><td><a id="l210"></a><a href="#l210">210</a><td>};<tr><td><a id="l211"></a><a href="#l211">211</a><td><tr><td><a id="l212"></a><a href="#l212">212</a><td><tr><td><a id="l213"></a><a href="#l213">213</a><td>/**<tr><td><a id="l214"></a><a href="#l214">214</a><td> * Flick, starting anywhere on the screen, at speed xspeed and yspeed.<tr><td><a id="l215"></a><a href="#l215">215</a><td> *<tr><td><a id="l216"></a><a href="#l216">216</a><td> * @param {{xspeed: number, yspeed: number}} speed The speed to flick in each<tr><td><a id="l217"></a><a href="#l217">217</a><td> direction, in pixels per second.<tr><td><a id="l218"></a><a href="#l218">218</a><td> * @return {!webdriver.TouchSequence} A self reference.<tr><td><a id="l219"></a><a href="#l219">219</a><td> */<tr><td><a id="l220"></a><a href="#l220">220</a><td>webdriver.TouchSequence.prototype.flick = function(speed) {<tr><td><a id="l221"></a><a href="#l221">221</a><td> var command = new webdriver.Command(webdriver.CommandName.TOUCH_FLICK).<tr><td><a id="l222"></a><a href="#l222">222</a><td> setParameter('xspeed', speed.xspeed).<tr><td><a id="l223"></a><a href="#l223">223</a><td> setParameter('yspeed', speed.yspeed);<tr><td><a id="l224"></a><a href="#l224">224</a><td><tr><td><a id="l225"></a><a href="#l225">225</a><td> this.schedule_('flick', command);<tr><td><a id="l226"></a><a href="#l226">226</a><td> return this;<tr><td><a id="l227"></a><a href="#l227">227</a><td>};<tr><td><a id="l228"></a><a href="#l228">228</a><td><tr><td><a id="l229"></a><a href="#l229">229</a><td><tr><td><a id="l230"></a><a href="#l230">230</a><td>/**<tr><td><a id="l231"></a><a href="#l231">231</a><td> * Flick starting at elem and moving by x and y at specified speed.<tr><td><a id="l232"></a><a href="#l232">232</a><td> *<tr><td><a id="l233"></a><a href="#l233">233</a><td> * @param {!webdriver.WebElement} elem The element where flick starts.<tr><td><a id="l234"></a><a href="#l234">234</a><td> * @param {{x: number, y: number}} offset The offset to flick to.<tr><td><a id="l235"></a><a href="#l235">235</a><td> * @param {number} speed The speed to flick at in pixels per second.<tr><td><a id="l236"></a><a href="#l236">236</a><td> * @return {!webdriver.TouchSequence} A self reference.<tr><td><a id="l237"></a><a href="#l237">237</a><td> */<tr><td><a id="l238"></a><a href="#l238">238</a><td>webdriver.TouchSequence.prototype.flickElement = function(elem, offset, speed) {<tr><td><a id="l239"></a><a href="#l239">239</a><td> var command = new webdriver.Command(webdriver.CommandName.TOUCH_FLICK).<tr><td><a id="l240"></a><a href="#l240">240</a><td> setParameter('element', elem.getRawId()).<tr><td><a id="l241"></a><a href="#l241">241</a><td> setParameter('xoffset', offset.x).<tr><td><a id="l242"></a><a href="#l242">242</a><td> setParameter('yoffset', offset.y).<tr><td><a id="l243"></a><a href="#l243">243</a><td> setParameter('speed', speed);<tr><td><a id="l244"></a><a href="#l244">244</a><td><tr><td><a id="l245"></a><a href="#l245">245</a><td> this.schedule_('flickElement', command);<tr><td><a id="l246"></a><a href="#l246">246</a><td> return this;<tr><td><a id="l247"></a><a href="#l247">247</a><td>};<tr><td><a id="l248"></a><a href="#l248">248</a><td></table></div></article><nav><h3><a href="../../../index.html" tabindex="2">Overview</a></h3><div><input type="checkbox" id="nav-modules" checked/><label for="nav-modules"><h3><span class="selectable" tabindex="2">Modules</span></h3></label><div id="nav-modules-view"></div></div><div><input type="checkbox" id="nav-types" checked/><label for="nav-types"><h3><span class="selectable" tabindex="2">Types</span></h3></label><div id="nav-types-view"></div></div><h3><a href="../../../Changes.html" tabindex="2">Changes</a></h3></nav></main><footer><div><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></div></footer><script src="../../../types.js"></script><script src="../../../dossier.js"></script>