selenium-webdriver

Version:

The official WebDriver JavaScript bindings from the Selenium project

1 lines • 32.8 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>actionsequence.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/actionsequence.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.ActionSequence');<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.Button');<tr><td><a id="l22"></a><a href="#l22">22</a><td>goog.require('webdriver.Command');<tr><td><a id="l23"></a><a href="#l23">23</a><td>goog.require('webdriver.CommandName');<tr><td><a id="l24"></a><a href="#l24">24</a><td>goog.require('webdriver.Key');<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><tr><td><a id="l28"></a><a href="#l28">28</a><td>/**<tr><td><a id="l29"></a><a href="#l29">29</a><td> * Class for defining sequences of complex user interactions. Each sequence<tr><td><a id="l30"></a><a href="#l30">30</a><td> * will not be executed until {@link #perform} is called.<tr><td><a id="l31"></a><a href="#l31">31</a><td> *<tr><td><a id="l32"></a><a href="#l32">32</a><td> * Example:<tr><td><a id="l33"></a><a href="#l33">33</a><td> *<tr><td><a id="l34"></a><a href="#l34">34</a><td> * new webdriver.ActionSequence(driver).<tr><td><a id="l35"></a><a href="#l35">35</a><td> * keyDown(webdriver.Key.SHIFT).<tr><td><a id="l36"></a><a href="#l36">36</a><td> * click(element1).<tr><td><a id="l37"></a><a href="#l37">37</a><td> * click(element2).<tr><td><a id="l38"></a><a href="#l38">38</a><td> * dragAndDrop(element3, element4).<tr><td><a id="l39"></a><a href="#l39">39</a><td> * keyUp(webdriver.Key.SHIFT).<tr><td><a id="l40"></a><a href="#l40">40</a><td> * perform();<tr><td><a id="l41"></a><a href="#l41">41</a><td> *<tr><td><a id="l42"></a><a href="#l42">42</a><td> * @param {!webdriver.WebDriver} driver The driver instance to use.<tr><td><a id="l43"></a><a href="#l43">43</a><td> * @constructor<tr><td><a id="l44"></a><a href="#l44">44</a><td> */<tr><td><a id="l45"></a><a href="#l45">45</a><td>webdriver.ActionSequence = function(driver) {<tr><td><a id="l46"></a><a href="#l46">46</a><td><tr><td><a id="l47"></a><a href="#l47">47</a><td> /** @private {!webdriver.WebDriver} */<tr><td><a id="l48"></a><a href="#l48">48</a><td> this.driver_ = driver;<tr><td><a id="l49"></a><a href="#l49">49</a><td><tr><td><a id="l50"></a><a href="#l50">50</a><td> /** @private {!Array.<{description: string, command: !webdriver.Command}>} */<tr><td><a id="l51"></a><a href="#l51">51</a><td> this.actions_ = [];<tr><td><a id="l52"></a><a href="#l52">52</a><td>};<tr><td><a id="l53"></a><a href="#l53">53</a><td><tr><td><a id="l54"></a><a href="#l54">54</a><td><tr><td><a id="l55"></a><a href="#l55">55</a><td>/**<tr><td><a id="l56"></a><a href="#l56">56</a><td> * Schedules an action to be executed each time {@link #perform} is called on<tr><td><a id="l57"></a><a href="#l57">57</a><td> * this instance.<tr><td><a id="l58"></a><a href="#l58">58</a><td> * @param {string} description A description of the command.<tr><td><a id="l59"></a><a href="#l59">59</a><td> * @param {!webdriver.Command} command The command.<tr><td><a id="l60"></a><a href="#l60">60</a><td> * @private<tr><td><a id="l61"></a><a href="#l61">61</a><td> */<tr><td><a id="l62"></a><a href="#l62">62</a><td>webdriver.ActionSequence.prototype.schedule_ = function(description, command) {<tr><td><a id="l63"></a><a href="#l63">63</a><td> this.actions_.push({<tr><td><a id="l64"></a><a href="#l64">64</a><td> description: description,<tr><td><a id="l65"></a><a href="#l65">65</a><td> command: command<tr><td><a id="l66"></a><a href="#l66">66</a><td> });<tr><td><a id="l67"></a><a href="#l67">67</a><td>};<tr><td><a id="l68"></a><a href="#l68">68</a><td><tr><td><a id="l69"></a><a href="#l69">69</a><td><tr><td><a id="l70"></a><a href="#l70">70</a><td>/**<tr><td><a id="l71"></a><a href="#l71">71</a><td> * Executes this action sequence.<tr><td><a id="l72"></a><a href="#l72">72</a><td> * @return {!webdriver.promise.Promise} A promise that will be resolved once<tr><td><a id="l73"></a><a href="#l73">73</a><td> * this sequence has completed.<tr><td><a id="l74"></a><a href="#l74">74</a><td> */<tr><td><a id="l75"></a><a href="#l75">75</a><td>webdriver.ActionSequence.prototype.perform = function() {<tr><td><a id="l76"></a><a href="#l76">76</a><td> // Make a protected copy of the scheduled actions. This will protect against<tr><td><a id="l77"></a><a href="#l77">77</a><td> // users defining additional commands before this sequence is actually<tr><td><a id="l78"></a><a href="#l78">78</a><td> // executed.<tr><td><a id="l79"></a><a href="#l79">79</a><td> var actions = goog.array.clone(this.actions_);<tr><td><a id="l80"></a><a href="#l80">80</a><td> var driver = this.driver_;<tr><td><a id="l81"></a><a href="#l81">81</a><td> return driver.controlFlow().execute(function() {<tr><td><a id="l82"></a><a href="#l82">82</a><td> goog.array.forEach(actions, function(action) {<tr><td><a id="l83"></a><a href="#l83">83</a><td> driver.schedule(action.command, action.description);<tr><td><a id="l84"></a><a href="#l84">84</a><td> });<tr><td><a id="l85"></a><a href="#l85">85</a><td> }, 'ActionSequence.perform');<tr><td><a id="l86"></a><a href="#l86">86</a><td>};<tr><td><a id="l87"></a><a href="#l87">87</a><td><tr><td><a id="l88"></a><a href="#l88">88</a><td><tr><td><a id="l89"></a><a href="#l89">89</a><td>/**<tr><td><a id="l90"></a><a href="#l90">90</a><td> * Moves the mouse. The location to move to may be specified in terms of the<tr><td><a id="l91"></a><a href="#l91">91</a><td> * mouse's current location, an offset relative to the top-left corner of an<tr><td><a id="l92"></a><a href="#l92">92</a><td> * element, or an element (in which case the middle of the element is used).<tr><td><a id="l93"></a><a href="#l93">93</a><td> * @param {(!webdriver.WebElement|{x: number, y: number})} location The<tr><td><a id="l94"></a><a href="#l94">94</a><td> * location to drag to, as either another WebElement or an offset in pixels.<tr><td><a id="l95"></a><a href="#l95">95</a><td> * @param {{x: number, y: number}=} opt_offset If the target {@code location}<tr><td><a id="l96"></a><a href="#l96">96</a><td> * is defined as a {@link webdriver.WebElement}, this parameter defines an<tr><td><a id="l97"></a><a href="#l97">97</a><td> * offset within that element. The offset should be specified in pixels<tr><td><a id="l98"></a><a href="#l98">98</a><td> * relative to the top-left corner of the element's bounding box. If<tr><td><a id="l99"></a><a href="#l99">99</a><td> * omitted, the element's center will be used as the target offset.<tr><td><a id="l100"></a><a href="#l100">100</a><td> * @return {!webdriver.ActionSequence} A self reference.<tr><td><a id="l101"></a><a href="#l101">101</a><td> */<tr><td><a id="l102"></a><a href="#l102">102</a><td>webdriver.ActionSequence.prototype.mouseMove = function(location, opt_offset) {<tr><td><a id="l103"></a><a href="#l103">103</a><td> var command = new webdriver.Command(webdriver.CommandName.MOVE_TO);<tr><td><a id="l104"></a><a href="#l104">104</a><td><tr><td><a id="l105"></a><a href="#l105">105</a><td> if (goog.isNumber(location.x)) {<tr><td><a id="l106"></a><a href="#l106">106</a><td> setOffset(/** @type {{x: number, y: number}} */(location));<tr><td><a id="l107"></a><a href="#l107">107</a><td> } else {<tr><td><a id="l108"></a><a href="#l108">108</a><td> command.setParameter('element', location.getRawId());<tr><td><a id="l109"></a><a href="#l109">109</a><td> if (opt_offset) {<tr><td><a id="l110"></a><a href="#l110">110</a><td> setOffset(opt_offset);<tr><td><a id="l111"></a><a href="#l111">111</a><td> }<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> this.schedule_('mouseMove', command);<tr><td><a id="l115"></a><a href="#l115">115</a><td> return this;<tr><td><a id="l116"></a><a href="#l116">116</a><td><tr><td><a id="l117"></a><a href="#l117">117</a><td> /** @param {{x: number, y: number}} offset The offset to use. */<tr><td><a id="l118"></a><a href="#l118">118</a><td> function setOffset(offset) {<tr><td><a id="l119"></a><a href="#l119">119</a><td> command.setParameter('xoffset', offset.x || 0);<tr><td><a id="l120"></a><a href="#l120">120</a><td> command.setParameter('yoffset', offset.y || 0);<tr><td><a id="l121"></a><a href="#l121">121</a><td> }<tr><td><a id="l122"></a><a href="#l122">122</a><td>};<tr><td><a id="l123"></a><a href="#l123">123</a><td><tr><td><a id="l124"></a><a href="#l124">124</a><td><tr><td><a id="l125"></a><a href="#l125">125</a><td>/**<tr><td><a id="l126"></a><a href="#l126">126</a><td> * Schedules a mouse action.<tr><td><a id="l127"></a><a href="#l127">127</a><td> * @param {string} description A simple descriptive label for the scheduled<tr><td><a id="l128"></a><a href="#l128">128</a><td> * action.<tr><td><a id="l129"></a><a href="#l129">129</a><td> * @param {!webdriver.CommandName} commandName The name of the command.<tr><td><a id="l130"></a><a href="#l130">130</a><td> * @param {(webdriver.WebElement|webdriver.Button)=} opt_elementOrButton Either<tr><td><a id="l131"></a><a href="#l131">131</a><td> * the element to interact with or the button to click with.<tr><td><a id="l132"></a><a href="#l132">132</a><td> * Defaults to {@link webdriver.Button.LEFT} if neither an element nor<tr><td><a id="l133"></a><a href="#l133">133</a><td> * button is specified.<tr><td><a id="l134"></a><a href="#l134">134</a><td> * @param {webdriver.Button=} opt_button The button to use. Defaults to<tr><td><a id="l135"></a><a href="#l135">135</a><td> * {@link webdriver.Button.LEFT}. Ignored if the previous argument is<tr><td><a id="l136"></a><a href="#l136">136</a><td> * provided as a button.<tr><td><a id="l137"></a><a href="#l137">137</a><td> * @return {!webdriver.ActionSequence} A self reference.<tr><td><a id="l138"></a><a href="#l138">138</a><td> * @private<tr><td><a id="l139"></a><a href="#l139">139</a><td> */<tr><td><a id="l140"></a><a href="#l140">140</a><td>webdriver.ActionSequence.prototype.scheduleMouseAction_ = function(<tr><td><a id="l141"></a><a href="#l141">141</a><td> description, commandName, opt_elementOrButton, opt_button) {<tr><td><a id="l142"></a><a href="#l142">142</a><td> var button;<tr><td><a id="l143"></a><a href="#l143">143</a><td> if (goog.isNumber(opt_elementOrButton)) {<tr><td><a id="l144"></a><a href="#l144">144</a><td> button = opt_elementOrButton;<tr><td><a id="l145"></a><a href="#l145">145</a><td> } else {<tr><td><a id="l146"></a><a href="#l146">146</a><td> if (opt_elementOrButton) {<tr><td><a id="l147"></a><a href="#l147">147</a><td> this.mouseMove(<tr><td><a id="l148"></a><a href="#l148">148</a><td> /** @type {!webdriver.WebElement} */ (opt_elementOrButton));<tr><td><a id="l149"></a><a href="#l149">149</a><td> }<tr><td><a id="l150"></a><a href="#l150">150</a><td> button = goog.isDef(opt_button) ? opt_button : webdriver.Button.LEFT;<tr><td><a id="l151"></a><a href="#l151">151</a><td> }<tr><td><a id="l152"></a><a href="#l152">152</a><td><tr><td><a id="l153"></a><a href="#l153">153</a><td> var command = new webdriver.Command(commandName).<tr><td><a id="l154"></a><a href="#l154">154</a><td> setParameter('button', button);<tr><td><a id="l155"></a><a href="#l155">155</a><td> this.schedule_(description, command);<tr><td><a id="l156"></a><a href="#l156">156</a><td> return this;<tr><td><a id="l157"></a><a href="#l157">157</a><td>};<tr><td><a id="l158"></a><a href="#l158">158</a><td><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> * Presses a mouse button. The mouse button will not be released until<tr><td><a id="l162"></a><a href="#l162">162</a><td> * {@link #mouseUp} is called, regardless of whether that call is made in this<tr><td><a id="l163"></a><a href="#l163">163</a><td> * sequence or another. The behavior for out-of-order events (e.g. mouseDown,<tr><td><a id="l164"></a><a href="#l164">164</a><td> * click) is undefined.<tr><td><a id="l165"></a><a href="#l165">165</a><td> *<tr><td><a id="l166"></a><a href="#l166">166</a><td> * If an element is provided, the mouse will first be moved to the center<tr><td><a id="l167"></a><a href="#l167">167</a><td> * of that element. This is equivalent to:<tr><td><a id="l168"></a><a href="#l168">168</a><td> *<tr><td><a id="l169"></a><a href="#l169">169</a><td> * sequence.mouseMove(element).mouseDown()<tr><td><a id="l170"></a><a href="#l170">170</a><td> *<tr><td><a id="l171"></a><a href="#l171">171</a><td> * Warning: this method currently only supports the left mouse button. See<tr><td><a id="l172"></a><a href="#l172">172</a><td> * [issue 4047](http://code.google.com/p/selenium/issues/detail?id=4047).<tr><td><a id="l173"></a><a href="#l173">173</a><td> *<tr><td><a id="l174"></a><a href="#l174">174</a><td> * @param {(webdriver.WebElement|webdriver.Button)=} opt_elementOrButton Either<tr><td><a id="l175"></a><a href="#l175">175</a><td> * the element to interact with or the button to click with.<tr><td><a id="l176"></a><a href="#l176">176</a><td> * Defaults to {@link webdriver.Button.LEFT} if neither an element nor<tr><td><a id="l177"></a><a href="#l177">177</a><td> * button is specified.<tr><td><a id="l178"></a><a href="#l178">178</a><td> * @param {webdriver.Button=} opt_button The button to use. Defaults to<tr><td><a id="l179"></a><a href="#l179">179</a><td> * {@link webdriver.Button.LEFT}. Ignored if a button is provided as the<tr><td><a id="l180"></a><a href="#l180">180</a><td> * first argument.<tr><td><a id="l181"></a><a href="#l181">181</a><td> * @return {!webdriver.ActionSequence} A self reference.<tr><td><a id="l182"></a><a href="#l182">182</a><td> */<tr><td><a id="l183"></a><a href="#l183">183</a><td>webdriver.ActionSequence.prototype.mouseDown = function(opt_elementOrButton,<tr><td><a id="l184"></a><a href="#l184">184</a><td> opt_button) {<tr><td><a id="l185"></a><a href="#l185">185</a><td> return this.scheduleMouseAction_('mouseDown',<tr><td><a id="l186"></a><a href="#l186">186</a><td> webdriver.CommandName.MOUSE_DOWN, opt_elementOrButton, opt_button);<tr><td><a id="l187"></a><a href="#l187">187</a><td>};<tr><td><a id="l188"></a><a href="#l188">188</a><td><tr><td><a id="l189"></a><a href="#l189">189</a><td><tr><td><a id="l190"></a><a href="#l190">190</a><td>/**<tr><td><a id="l191"></a><a href="#l191">191</a><td> * Releases a mouse button. Behavior is undefined for calling this function<tr><td><a id="l192"></a><a href="#l192">192</a><td> * without a previous call to {@link #mouseDown}.<tr><td><a id="l193"></a><a href="#l193">193</a><td> *<tr><td><a id="l194"></a><a href="#l194">194</a><td> * If an element is provided, the mouse will first be moved to the center<tr><td><a id="l195"></a><a href="#l195">195</a><td> * of that element. This is equivalent to:<tr><td><a id="l196"></a><a href="#l196">196</a><td> *<tr><td><a id="l197"></a><a href="#l197">197</a><td> * sequence.mouseMove(element).mouseUp()<tr><td><a id="l198"></a><a href="#l198">198</a><td> *<tr><td><a id="l199"></a><a href="#l199">199</a><td> * Warning: this method currently only supports the left mouse button. See<tr><td><a id="l200"></a><a href="#l200">200</a><td> * [issue 4047](http://code.google.com/p/selenium/issues/detail?id=4047).<tr><td><a id="l201"></a><a href="#l201">201</a><td> *<tr><td><a id="l202"></a><a href="#l202">202</a><td> * @param {(webdriver.WebElement|webdriver.Button)=} opt_elementOrButton Either<tr><td><a id="l203"></a><a href="#l203">203</a><td> * the element to interact with or the button to click with.<tr><td><a id="l204"></a><a href="#l204">204</a><td> * Defaults to {@link webdriver.Button.LEFT} if neither an element nor<tr><td><a id="l205"></a><a href="#l205">205</a><td> * button is specified.<tr><td><a id="l206"></a><a href="#l206">206</a><td> * @param {webdriver.Button=} opt_button The button to use. Defaults to<tr><td><a id="l207"></a><a href="#l207">207</a><td> * {@link webdriver.Button.LEFT}. Ignored if a button is provided as the<tr><td><a id="l208"></a><a href="#l208">208</a><td> * first argument.<tr><td><a id="l209"></a><a href="#l209">209</a><td> * @return {!webdriver.ActionSequence} A self reference.<tr><td><a id="l210"></a><a href="#l210">210</a><td> */<tr><td><a id="l211"></a><a href="#l211">211</a><td>webdriver.ActionSequence.prototype.mouseUp = function(opt_elementOrButton,<tr><td><a id="l212"></a><a href="#l212">212</a><td> opt_button) {<tr><td><a id="l213"></a><a href="#l213">213</a><td> return this.scheduleMouseAction_('mouseUp',<tr><td><a id="l214"></a><a href="#l214">214</a><td> webdriver.CommandName.MOUSE_UP, opt_elementOrButton, opt_button);<tr><td><a id="l215"></a><a href="#l215">215</a><td>};<tr><td><a id="l216"></a><a href="#l216">216</a><td><tr><td><a id="l217"></a><a href="#l217">217</a><td><tr><td><a id="l218"></a><a href="#l218">218</a><td>/**<tr><td><a id="l219"></a><a href="#l219">219</a><td> * Convenience function for performing a "drag and drop" manuever. The target<tr><td><a id="l220"></a><a href="#l220">220</a><td> * element may be moved to the location of another element, or by an offset (in<tr><td><a id="l221"></a><a href="#l221">221</a><td> * pixels).<tr><td><a id="l222"></a><a href="#l222">222</a><td> * @param {!webdriver.WebElement} element The element to drag.<tr><td><a id="l223"></a><a href="#l223">223</a><td> * @param {(!webdriver.WebElement|{x: number, y: number})} location The<tr><td><a id="l224"></a><a href="#l224">224</a><td> * location to drag to, either as another WebElement or an offset in pixels.<tr><td><a id="l225"></a><a href="#l225">225</a><td> * @return {!webdriver.ActionSequence} A self reference.<tr><td><a id="l226"></a><a href="#l226">226</a><td> */<tr><td><a id="l227"></a><a href="#l227">227</a><td>webdriver.ActionSequence.prototype.dragAndDrop = function(element, location) {<tr><td><a id="l228"></a><a href="#l228">228</a><td> return this.mouseDown(element).mouseMove(location).mouseUp();<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><tr><td><a id="l232"></a><a href="#l232">232</a><td>/**<tr><td><a id="l233"></a><a href="#l233">233</a><td> * Clicks a mouse button.<tr><td><a id="l234"></a><a href="#l234">234</a><td> *<tr><td><a id="l235"></a><a href="#l235">235</a><td> * If an element is provided, the mouse will first be moved to the center<tr><td><a id="l236"></a><a href="#l236">236</a><td> * of that element. This is equivalent to:<tr><td><a id="l237"></a><a href="#l237">237</a><td> *<tr><td><a id="l238"></a><a href="#l238">238</a><td> * sequence.mouseMove(element).click()<tr><td><a id="l239"></a><a href="#l239">239</a><td> *<tr><td><a id="l240"></a><a href="#l240">240</a><td> * @param {(webdriver.WebElement|webdriver.Button)=} opt_elementOrButton Either<tr><td><a id="l241"></a><a href="#l241">241</a><td> * the element to interact with or the button to click with.<tr><td><a id="l242"></a><a href="#l242">242</a><td> * Defaults to {@link webdriver.Button.LEFT} if neither an element nor<tr><td><a id="l243"></a><a href="#l243">243</a><td> * button is specified.<tr><td><a id="l244"></a><a href="#l244">244</a><td> * @param {webdriver.Button=} opt_button The button to use. Defaults to<tr><td><a id="l245"></a><a href="#l245">245</a><td> * {@link webdriver.Button.LEFT}. Ignored if a button is provided as the<tr><td><a id="l246"></a><a href="#l246">246</a><td> * first argument.<tr><td><a id="l247"></a><a href="#l247">247</a><td> * @return {!webdriver.ActionSequence} A self reference.<tr><td><a id="l248"></a><a href="#l248">248</a><td> */<tr><td><a id="l249"></a><a href="#l249">249</a><td>webdriver.ActionSequence.prototype.click = function(opt_elementOrButton,<tr><td><a id="l250"></a><a href="#l250">250</a><td> opt_button) {<tr><td><a id="l251"></a><a href="#l251">251</a><td> return this.scheduleMouseAction_('click',<tr><td><a id="l252"></a><a href="#l252">252</a><td> webdriver.CommandName.CLICK, opt_elementOrButton, opt_button);<tr><td><a id="l253"></a><a href="#l253">253</a><td>};<tr><td><a id="l254"></a><a href="#l254">254</a><td><tr><td><a id="l255"></a><a href="#l255">255</a><td><tr><td><a id="l256"></a><a href="#l256">256</a><td>/**<tr><td><a id="l257"></a><a href="#l257">257</a><td> * Double-clicks a mouse button.<tr><td><a id="l258"></a><a href="#l258">258</a><td> *<tr><td><a id="l259"></a><a href="#l259">259</a><td> * If an element is provided, the mouse will first be moved to the center of<tr><td><a id="l260"></a><a href="#l260">260</a><td> * that element. This is equivalent to:<tr><td><a id="l261"></a><a href="#l261">261</a><td> *<tr><td><a id="l262"></a><a href="#l262">262</a><td> * sequence.mouseMove(element).doubleClick()<tr><td><a id="l263"></a><a href="#l263">263</a><td> *<tr><td><a id="l264"></a><a href="#l264">264</a><td> * Warning: this method currently only supports the left mouse button. See<tr><td><a id="l265"></a><a href="#l265">265</a><td> * [issue 4047](http://code.google.com/p/selenium/issues/detail?id=4047).<tr><td><a id="l266"></a><a href="#l266">266</a><td> *<tr><td><a id="l267"></a><a href="#l267">267</a><td> * @param {(webdriver.WebElement|webdriver.Button)=} opt_elementOrButton Either<tr><td><a id="l268"></a><a href="#l268">268</a><td> * the element to interact with or the button to click with.<tr><td><a id="l269"></a><a href="#l269">269</a><td> * Defaults to {@link webdriver.Button.LEFT} if neither an element nor<tr><td><a id="l270"></a><a href="#l270">270</a><td> * button is specified.<tr><td><a id="l271"></a><a href="#l271">271</a><td> * @param {webdriver.Button=} opt_button The button to use. Defaults to<tr><td><a id="l272"></a><a href="#l272">272</a><td> * {@link webdriver.Button.LEFT}. Ignored if a button is provided as the<tr><td><a id="l273"></a><a href="#l273">273</a><td> * first argument.<tr><td><a id="l274"></a><a href="#l274">274</a><td> * @return {!webdriver.ActionSequence} A self reference.<tr><td><a id="l275"></a><a href="#l275">275</a><td> */<tr><td><a id="l276"></a><a href="#l276">276</a><td>webdriver.ActionSequence.prototype.doubleClick = function(opt_elementOrButton,<tr><td><a id="l277"></a><a href="#l277">277</a><td> opt_button) {<tr><td><a id="l278"></a><a href="#l278">278</a><td> return this.scheduleMouseAction_('doubleClick',<tr><td><a id="l279"></a><a href="#l279">279</a><td> webdriver.CommandName.DOUBLE_CLICK, opt_elementOrButton, opt_button);<tr><td><a id="l280"></a><a href="#l280">280</a><td>};<tr><td><a id="l281"></a><a href="#l281">281</a><td><tr><td><a id="l282"></a><a href="#l282">282</a><td><tr><td><a id="l283"></a><a href="#l283">283</a><td>/**<tr><td><a id="l284"></a><a href="#l284">284</a><td> * Schedules a keyboard action.<tr><td><a id="l285"></a><a href="#l285">285</a><td> * @param {string} description A simple descriptive label for the scheduled<tr><td><a id="l286"></a><a href="#l286">286</a><td> * action.<tr><td><a id="l287"></a><a href="#l287">287</a><td> * @param {!Array.<(string|!webdriver.Key)>} keys The keys to send.<tr><td><a id="l288"></a><a href="#l288">288</a><td> * @return {!webdriver.ActionSequence} A self reference.<tr><td><a id="l289"></a><a href="#l289">289</a><td> * @private<tr><td><a id="l290"></a><a href="#l290">290</a><td> */<tr><td><a id="l291"></a><a href="#l291">291</a><td>webdriver.ActionSequence.prototype.scheduleKeyboardAction_ = function(<tr><td><a id="l292"></a><a href="#l292">292</a><td> description, keys) {<tr><td><a id="l293"></a><a href="#l293">293</a><td> var command =<tr><td><a id="l294"></a><a href="#l294">294</a><td> new webdriver.Command(webdriver.CommandName.SEND_KEYS_TO_ACTIVE_ELEMENT).<tr><td><a id="l295"></a><a href="#l295">295</a><td> setParameter('value', keys);<tr><td><a id="l296"></a><a href="#l296">296</a><td> this.schedule_(description, command);<tr><td><a id="l297"></a><a href="#l297">297</a><td> return this;<tr><td><a id="l298"></a><a href="#l298">298</a><td>};<tr><td><a id="l299"></a><a href="#l299">299</a><td><tr><td><a id="l300"></a><a href="#l300">300</a><td><tr><td><a id="l301"></a><a href="#l301">301</a><td>/**<tr><td><a id="l302"></a><a href="#l302">302</a><td> * Checks that a key is a modifier key.<tr><td><a id="l303"></a><a href="#l303">303</a><td> * @param {!webdriver.Key} key The key to check.<tr><td><a id="l304"></a><a href="#l304">304</a><td> * @throws {Error} If the key is not a modifier key.<tr><td><a id="l305"></a><a href="#l305">305</a><td> * @private<tr><td><a id="l306"></a><a href="#l306">306</a><td> */<tr><td><a id="l307"></a><a href="#l307">307</a><td>webdriver.ActionSequence.checkModifierKey_ = function(key) {<tr><td><a id="l308"></a><a href="#l308">308</a><td> if (key !== webdriver.Key.ALT && key !== webdriver.Key.CONTROL &&<tr><td><a id="l309"></a><a href="#l309">309</a><td> key !== webdriver.Key.SHIFT && key !== webdriver.Key.COMMAND) {<tr><td><a id="l310"></a><a href="#l310">310</a><td> throw Error('Not a modifier key');<tr><td><a id="l311"></a><a href="#l311">311</a><td> }<tr><td><a id="l312"></a><a href="#l312">312</a><td>};<tr><td><a id="l313"></a><a href="#l313">313</a><td><tr><td><a id="l314"></a><a href="#l314">314</a><td><tr><td><a id="l315"></a><a href="#l315">315</a><td>/**<tr><td><a id="l316"></a><a href="#l316">316</a><td> * Performs a modifier key press. The modifier key is <em>not released</em><tr><td><a id="l317"></a><a href="#l317">317</a><td> * until {@link #keyUp} or {@link #sendKeys} is called. The key press will be<tr><td><a id="l318"></a><a href="#l318">318</a><td> * targetted at the currently focused element.<tr><td><a id="l319"></a><a href="#l319">319</a><td> * @param {!webdriver.Key} key The modifier key to push. Must be one of<tr><td><a id="l320"></a><a href="#l320">320</a><td> * {ALT, CONTROL, SHIFT, COMMAND, META}.<tr><td><a id="l321"></a><a href="#l321">321</a><td> * @return {!webdriver.ActionSequence} A self reference.<tr><td><a id="l322"></a><a href="#l322">322</a><td> * @throws {Error} If the key is not a valid modifier key.<tr><td><a id="l323"></a><a href="#l323">323</a><td> */<tr><td><a id="l324"></a><a href="#l324">324</a><td>webdriver.ActionSequence.prototype.keyDown = function(key) {<tr><td><a id="l325"></a><a href="#l325">325</a><td> webdriver.ActionSequence.checkModifierKey_(key);<tr><td><a id="l326"></a><a href="#l326">326</a><td> return this.scheduleKeyboardAction_('keyDown', [key]);<tr><td><a id="l327"></a><a href="#l327">327</a><td>};<tr><td><a id="l328"></a><a href="#l328">328</a><td><tr><td><a id="l329"></a><a href="#l329">329</a><td><tr><td><a id="l330"></a><a href="#l330">330</a><td>/**<tr><td><a id="l331"></a><a href="#l331">331</a><td> * Performs a modifier key release. The release is targetted at the currently<tr><td><a id="l332"></a><a href="#l332">332</a><td> * focused element.<tr><td><a id="l333"></a><a href="#l333">333</a><td> * @param {!webdriver.Key} key The modifier key to release. Must be one of<tr><td><a id="l334"></a><a href="#l334">334</a><td> * {ALT, CONTROL, SHIFT, COMMAND, META}.<tr><td><a id="l335"></a><a href="#l335">335</a><td> * @return {!webdriver.ActionSequence} A self reference.<tr><td><a id="l336"></a><a href="#l336">336</a><td> * @throws {Error} If the key is not a valid modifier key.<tr><td><a id="l337"></a><a href="#l337">337</a><td> */<tr><td><a id="l338"></a><a href="#l338">338</a><td>webdriver.ActionSequence.prototype.keyUp = function(key) {<tr><td><a id="l339"></a><a href="#l339">339</a><td> webdriver.ActionSequence.checkModifierKey_(key);<tr><td><a id="l340"></a><a href="#l340">340</a><td> return this.scheduleKeyboardAction_('keyUp', [key]);<tr><td><a id="l341"></a><a href="#l341">341</a><td>};<tr><td><a id="l342"></a><a href="#l342">342</a><td><tr><td><a id="l343"></a><a href="#l343">343</a><td><tr><td><a id="l344"></a><a href="#l344">344</a><td>/**<tr><td><a id="l345"></a><a href="#l345">345</a><td> * Simulates typing multiple keys. Each modifier key encountered in the<tr><td><a id="l346"></a><a href="#l346">346</a><td> * sequence will not be released until it is encountered again. All key events<tr><td><a id="l347"></a><a href="#l347">347</a><td> * will be targetted at the currently focused element.<tr><td><a id="l348"></a><a href="#l348">348</a><td> * @param {...(string|!webdriver.Key|!Array.<(string|!webdriver.Key)>)} var_args<tr><td><a id="l349"></a><a href="#l349">349</a><td> * The keys to type.<tr><td><a id="l350"></a><a href="#l350">350</a><td> * @return {!webdriver.ActionSequence} A self reference.<tr><td><a id="l351"></a><a href="#l351">351</a><td> * @throws {Error} If the key is not a valid modifier key.<tr><td><a id="l352"></a><a href="#l352">352</a><td> */<tr><td><a id="l353"></a><a href="#l353">353</a><td>webdriver.ActionSequence.prototype.sendKeys = function(var_args) {<tr><td><a id="l354"></a><a href="#l354">354</a><td> var keys = goog.array.flatten(goog.array.slice(arguments, 0));<tr><td><a id="l355"></a><a href="#l355">355</a><td> return this.scheduleKeyboardAction_('sendKeys', keys);<tr><td><a id="l356"></a><a href="#l356">356</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>