docs/api/rb/Selenium/WebDriver/ActionBuilder.html - external/selenium - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>
   Class: Selenium::WebDriver::ActionBuilder

     &mdash; Documentation by YARD 0.8.1

 </title>

   <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />

   <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />

 <script type="text/javascript" charset="utf-8">
   hasFrames = window.top.frames.main ? true : false;
   relpath = '../../';
   framesUrl = "../../frames.html#!" + escape(window.location.href);
 </script>


   <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>

   <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>


   </head>
   <body>
     <div id="header">
       <div id="menu">

     <a href="../../_index.html">Index (A)</a> &raquo;
     <span class='title'><span class='object_link'><a href="../../Selenium.html" title="Selenium (module)">Selenium</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../WebDriver.html" title="Selenium::WebDriver (module)">WebDriver</a></span></span>
      &raquo;
     <span class="title">ActionBuilder</span>


   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
 </div>

       <div id="search">

     <a class="full_list_link" id="class_list_link"
         href="../../class_list.html">
       Class List
     </a>

     <a class="full_list_link" id="method_list_link"
         href="../../method_list.html">
       Method List
     </a>

     <a class="full_list_link" id="file_list_link"
         href="../../file_list.html">
       File List
     </a>

 </div>
       <div class="clear"></div>
     </div>

     <iframe id="search_frame"></iframe>

     <div id="content"><h1>Class: Selenium::WebDriver::ActionBuilder


 </h1>

 <dl class="box">

     <dt class="r1">Inherits:</dt>
     <dd class="r1">
       <span class="inheritName">Object</span>

         <ul class="fullTree">
           <li>Object</li>

             <li class="next">Selenium::WebDriver::ActionBuilder</li>

         </ul>
         <a href="#" class="inheritanceTree">show all</a>

       </dd>


     <dt class="r2 last">Defined in:</dt>
     <dd class="r2 last">rb/lib/selenium/webdriver/common/action_builder.rb</dd>

 </dl>
 <div class="clear"></div>

 <h2>Overview</h2><div class="docstring">
   <div class="discussion">

 <p>The ActionBuilder provides the user a way to set up and perform complex
 user interactions.</p>

 <p>This class should not be instantiated directly, but is created by
 Selenium::WebDriver::DriverExtensions::HasInputDevices#action, which is
 available on Driver instances that support the user interaction API.</p>


   </div>
 </div>
 <div class="tags">

   <div class="examples">
     <p class="tag_title">Examples:</p>


       <pre class="example code">
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_key_down'>key_down</span><span class='lparen'>(</span><span class='symbol'>:shift</span><span class='rparen'>)</span><span class='period'>.</span>
               <span class='id identifier rubyid_click'>click</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='rparen'>)</span><span class='period'>.</span>
               <span class='id identifier rubyid_click'>click</span><span class='lparen'>(</span><span class='id identifier rubyid_second_element'>second_element</span><span class='rparen'>)</span><span class='period'>.</span>
               <span class='id identifier rubyid_key_up'>key_up</span><span class='lparen'>(</span><span class='symbol'>:shift</span><span class='rparen'>)</span><span class='period'>.</span>
               <span class='id identifier rubyid_drag_and_drop'>drag_and_drop</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='comma'>,</span> <span class='id identifier rubyid_third_element'>third_element</span><span class='rparen'>)</span><span class='period'>.</span>
               <span class='id identifier rubyid_perform'>perform</span></pre>

   </div>


 </div><div id="subclasses">
   <h2>Direct Known Subclasses</h2>
   <p class="children"><span class='object_link'><a href="TouchActionBuilder.html" title="Selenium::WebDriver::TouchActionBuilder (class)">TouchActionBuilder</a></span></p>
 </div>


     <h2>
       Instance Method Summary
       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
     </h2>

     <ul class="summary">

         <li class="public ">
   <span class="summary_signature">

       <a href="#click-instance_method" title="#click (instance method)">- (ActionBuilder) <strong>click</strong>(element = nil) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Clicks in the middle of the given element.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#click_and_hold-instance_method" title="#click_and_hold (instance method)">- (ActionBuilder) <strong>click_and_hold</strong>(element) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Clicks (without releasing) in the middle of the given element.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#context_click-instance_method" title="#context_click (instance method)">- (ActionBuilder) <strong>context_click</strong>(element) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Performs a context-click at middle of the given element.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#double_click-instance_method" title="#double_click (instance method)">- (ActionBuilder) <strong>double_click</strong>(element = nil) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Performs a double-click at middle of the given element.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#drag_and_drop-instance_method" title="#drag_and_drop (instance method)">- (ActionBuilder) <strong>drag_and_drop</strong>(source, target) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>A convenience method that performs click-and-hold at the location of the
 source element, moves to the location of the target element, then releases
 the mouse.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#drag_and_drop_by-instance_method" title="#drag_and_drop_by (instance method)">- (ActionBuilder) <strong>drag_and_drop_by</strong>(source, right_by, down_by) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>A convenience method that performs click-and-hold at the location of the
 source element, moves by a given offset, then releases the mouse.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#initialize-instance_method" title="#initialize (instance method)">- (ActionBuilder) <strong>initialize</strong>(mouse, keyboard) </a>


   </span>


     <span class="note title constructor">constructor</span>


   <span class="private note title">private</span>


     <span class="summary_desc"><div class='inline'>
 <p>A new instance of ActionBuilder.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#key_down-instance_method" title="#key_down (instance method)">- (ActionBuilder) <strong>key_down</strong>(*args) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Performs a modifier key press.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#key_up-instance_method" title="#key_up (instance method)">- (ActionBuilder) <strong>key_up</strong>(*args) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Performs a modifier key release.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#move_by-instance_method" title="#move_by (instance method)">- (ActionBuilder) <strong>move_by</strong>(right_by, down_by) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Moves the mouse from its current position (or 0,0) by the given offset.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#move_to-instance_method" title="#move_to (instance method)">- (ActionBuilder) <strong>move_to</strong>(element, right_by = nil, down_by = nil) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Moves the mouse to the middle of the given element.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#perform-instance_method" title="#perform (instance method)">- (Object) <strong>perform</strong> </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Executes the actions added to the builder.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#release-instance_method" title="#release (instance method)">- (ActionBuilder) <strong>release</strong>(element = nil) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Releases the depressed left mouse button at the current mouse location.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#send_keys-instance_method" title="#send_keys (instance method)">- (ActionBuilder) <strong>send_keys</strong>(*args) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Sends keys to the active element.</p>
 </div></span>

 </li>


     </ul>


 <div id="constructor_details" class="method_details_list">
   <h2>Constructor Details</h2>

     <div class="method_details first">
   <h3 class="signature first" id="initialize-instance_method">

     - (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>) <strong>initialize</strong>(mouse, keyboard)


 </h3><div class="docstring">
   <div class="discussion">
     <p class="note private">
   <strong>This method is part of a private API.</strong>
   You should avoid using this method if possible, as it may be removed or be changed in the future.
 </p>

 <p>A new instance of ActionBuilder</p>


   </div>
 </div>
 <div class="tags">


 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 28
 29
 30
 31
 32
 33
 34
 35</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 28</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_mouse'>mouse</span><span class='comma'>,</span> <span class='id identifier rubyid_keyboard'>keyboard</span><span class='rparen'>)</span>
   <span class='ivar'>@devices</span>    <span class='op'>=</span> <span class='lbrace'>{</span>
     <span class='symbol'>:mouse</span>    <span class='op'>=&gt;</span> <span class='id identifier rubyid_mouse'>mouse</span><span class='comma'>,</span>
     <span class='symbol'>:keyboard</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_keyboard'>keyboard</span>
   <span class='rbrace'>}</span>

   <span class='ivar'>@actions</span>  <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

 </div>


   <div id="instance_method_details" class="method_details_list">
     <h2>Instance Method Details</h2>


       <div class="method_details first">
   <h3 class="signature first" id="click-instance_method">

     - (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>) <strong>click</strong>(element = nil)


 </h3><div class="docstring">
   <div class="discussion">

 <p>Clicks in the middle of the given element. Equivalent to:</p>

 <pre class="code ruby"><code><span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_move_to'>move_to</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_click'>click</span></code></pre>

 <p>When no element is passed, the current mouse position will be clicked.</p>


   </div>
 </div>
 <div class="tags">

   <div class="examples">
     <p class="tag_title">Examples:</p>


         <p class="example_title"><div class='inline'>
 <p>Clicking on an element</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_el'>el</span> <span class='op'>=</span> <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>some_id</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_click'>click</span><span class='lparen'>(</span><span class='id identifier rubyid_el'>el</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>


         <p class="example_title"><div class='inline'>
 <p>Clicking at the current mouse position</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_click'>click</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>

   </div>
 <p class="tag_title">Parameters:</p>
 <ul class="param">

     <li>

         <span class='name'>element</span>


         <span class='type'>(<tt><span class='object_link'><a href="Element.html" title="Selenium::WebDriver::Element (class)">Selenium::WebDriver::Element</a></span></tt>)</span>


         <em class="default">(defaults to: <tt>nil</tt>)</em>


         &mdash;
         <div class='inline'>
 <p>An optional element to click.</p>
 </div>

     </li>

 </ul>

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>A self reference.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 186
 187
 188
 189</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 186</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_click'>click</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='ivar'>@actions</span> <span class='op'>&lt;&lt;</span> <span class='lbracket'>[</span><span class='symbol'>:mouse</span><span class='comma'>,</span> <span class='symbol'>:click</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_element'>element</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
   <span class='kw'>self</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="click_and_hold-instance_method">

     - (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>) <strong>click_and_hold</strong>(element)


 </h3><div class="docstring">
   <div class="discussion">

 <p>Clicks (without releasing) in the middle of the given element. This is
 equivalent to:</p>

 <pre class="code ruby"><code><span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_move_to'>move_to</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_click_and_hold'>click_and_hold</span></code></pre>


   </div>
 </div>
 <div class="tags">

   <div class="examples">
     <p class="tag_title">Examples:</p>


         <p class="example_title"><div class='inline'>
 <p>Clicking and holding on some element</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_el'>el</span> <span class='op'>=</span> <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>some_id</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_click_and_hold'>click_and_hold</span><span class='lparen'>(</span><span class='id identifier rubyid_el'>el</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>

   </div>
 <p class="tag_title">Parameters:</p>
 <ul class="param">

     <li>

         <span class='name'>element</span>


         <span class='type'>(<tt><span class='object_link'><a href="Element.html" title="Selenium::WebDriver::Element (class)">Selenium::WebDriver::Element</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>the element to move to and click.</p>
 </div>

     </li>

 </ul>

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>A self reference.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 145
 146
 147
 148</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 145</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_click_and_hold'>click_and_hold</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='rparen'>)</span>
   <span class='ivar'>@actions</span> <span class='op'>&lt;&lt;</span> <span class='lbracket'>[</span><span class='symbol'>:mouse</span><span class='comma'>,</span> <span class='symbol'>:down</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_element'>element</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
   <span class='kw'>self</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="context_click-instance_method">

     - (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>) <strong>context_click</strong>(element)


 </h3><div class="docstring">
   <div class="discussion">

 <p>Performs a context-click at middle of the given element. First performs a
 move_to to the location of the element.</p>


   </div>
 </div>
 <div class="tags">

   <div class="examples">
     <p class="tag_title">Examples:</p>


         <p class="example_title"><div class='inline'>
 <p>Context-click at middle of given element</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_el'>el</span> <span class='op'>=</span> <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>some_id</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_context_click'>context_click</span><span class='lparen'>(</span><span class='id identifier rubyid_el'>el</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>

   </div>
 <p class="tag_title">Parameters:</p>
 <ul class="param">

     <li>

         <span class='name'>element</span>


         <span class='type'>(<tt><span class='object_link'><a href="Element.html" title="Selenium::WebDriver::Element (class)">Selenium::WebDriver::Element</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>An element to context click.</p>
 </div>

     </li>

 </ul>

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>A self reference.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 282
 283
 284
 285</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 282</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_context_click'>context_click</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='rparen'>)</span>
   <span class='ivar'>@actions</span> <span class='op'>&lt;&lt;</span> <span class='lbracket'>[</span><span class='symbol'>:mouse</span><span class='comma'>,</span> <span class='symbol'>:context_click</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_element'>element</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
   <span class='kw'>self</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="double_click-instance_method">

     - (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>) <strong>double_click</strong>(element = nil)


 </h3><div class="docstring">
   <div class="discussion">

 <p>Performs a double-click at middle of the given element. Equivalent to:</p>

 <pre class="code ruby"><code><span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_move_to'>move_to</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_double_click'>double_click</span></code></pre>


   </div>
 </div>
 <div class="tags">

   <div class="examples">
     <p class="tag_title">Examples:</p>


         <p class="example_title"><div class='inline'>
 <p>Double click an element</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_el'>el</span> <span class='op'>=</span> <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>some_id</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_double_click'>double_click</span><span class='lparen'>(</span><span class='id identifier rubyid_el'>el</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>

   </div>
 <p class="tag_title">Parameters:</p>
 <ul class="param">

     <li>

         <span class='name'>element</span>


         <span class='type'>(<tt><span class='object_link'><a href="Element.html" title="Selenium::WebDriver::Element (class)">Selenium::WebDriver::Element</a></span></tt>)</span>


         <em class="default">(defaults to: <tt>nil</tt>)</em>


         &mdash;
         <div class='inline'>
 <p>An optional element to move to.</p>
 </div>

     </li>

 </ul>

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>A self reference.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 205
 206
 207
 208</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 205</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_double_click'>double_click</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='ivar'>@actions</span> <span class='op'>&lt;&lt;</span> <span class='lbracket'>[</span><span class='symbol'>:mouse</span><span class='comma'>,</span> <span class='symbol'>:double_click</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_element'>element</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
   <span class='kw'>self</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="drag_and_drop-instance_method">

     - (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>) <strong>drag_and_drop</strong>(source, target)


 </h3><div class="docstring">
   <div class="discussion">

 <p>A convenience method that performs click-and-hold at the location of the
 source element, moves to the location of the target element, then releases
 the mouse.</p>


   </div>
 </div>
 <div class="tags">

   <div class="examples">
     <p class="tag_title">Examples:</p>


         <p class="example_title"><div class='inline'>
 <p>Drag and drop one element onto another</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_el1'>el1</span> <span class='op'>=</span> <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>some_id1</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
 <span class='id identifier rubyid_el2'>el2</span> <span class='op'>=</span> <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>some_id2</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_drag_and_drop'>drag_and_drop</span><span class='lparen'>(</span><span class='id identifier rubyid_el1'>el1</span><span class='comma'>,</span> <span class='id identifier rubyid_el2'>el2</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>

   </div>
 <p class="tag_title">Parameters:</p>
 <ul class="param">

     <li>

         <span class='name'>source</span>


         <span class='type'>(<tt><span class='object_link'><a href="Element.html" title="Selenium::WebDriver::Element (class)">Selenium::WebDriver::Element</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>element to emulate button down at.</p>
 </div>

     </li>

     <li>

         <span class='name'>target</span>


         <span class='type'>(<tt><span class='object_link'><a href="Element.html" title="Selenium::WebDriver::Element (class)">Selenium::WebDriver::Element</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>element to move to and release the mouse at.</p>
 </div>

     </li>

 </ul>

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>A self reference.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 304
 305
 306
 307
 308
 309
 310</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 304</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_drag_and_drop'>drag_and_drop</span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='comma'>,</span> <span class='id identifier rubyid_target'>target</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_click_and_hold'>click_and_hold</span> <span class='id identifier rubyid_source'>source</span>
   <span class='id identifier rubyid_move_to'>move_to</span>        <span class='id identifier rubyid_target'>target</span>
   <span class='id identifier rubyid_release'>release</span>        <span class='id identifier rubyid_target'>target</span>

   <span class='kw'>self</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="drag_and_drop_by-instance_method">

     - (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>) <strong>drag_and_drop_by</strong>(source, right_by, down_by)


 </h3><div class="docstring">
   <div class="discussion">

 <p>A convenience method that performs click-and-hold at the location of the
 source element, moves by a given offset, then releases the mouse.</p>


   </div>
 </div>
 <div class="tags">

   <div class="examples">
     <p class="tag_title">Examples:</p>


         <p class="example_title"><div class='inline'>
 <p>Drag and drop an element by offset</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_el'>el</span> <span class='op'>=</span> <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>some_id1</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_drag_and_drop_by'>drag_and_drop_by</span><span class='lparen'>(</span><span class='id identifier rubyid_el'>el</span><span class='comma'>,</span> <span class='int'>100</span><span class='comma'>,</span> <span class='int'>100</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>

   </div>
 <p class="tag_title">Parameters:</p>
 <ul class="param">

     <li>

         <span class='name'>source</span>


         <span class='type'>(<tt><span class='object_link'><a href="Element.html" title="Selenium::WebDriver::Element (class)">Selenium::WebDriver::Element</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>Element to emulate button down at.</p>
 </div>

     </li>

     <li>

         <span class='name'>right_by</span>


         <span class='type'>(<tt>Integer</tt>)</span>


         &mdash;
         <div class='inline'>
 <p>horizontal move offset.</p>
 </div>

     </li>

     <li>

         <span class='name'>down_by</span>


         <span class='type'>(<tt>Integer</tt>)</span>


         &mdash;
         <div class='inline'>
 <p>vertical move offset.</p>
 </div>

     </li>

     <li>

         <span class='name'>target</span>


         <span class='type'>(<tt><span class='object_link'><a href="Element.html" title="Selenium::WebDriver::Element (class)">Selenium::WebDriver::Element</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>Element to move to and release the mouse at.</p>
 </div>

     </li>

 </ul>

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>A self reference.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 329
 330
 331
 332
 333
 334
 335</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 329</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_drag_and_drop_by'>drag_and_drop_by</span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='comma'>,</span> <span class='id identifier rubyid_right_by'>right_by</span><span class='comma'>,</span> <span class='id identifier rubyid_down_by'>down_by</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_click_and_hold'>click_and_hold</span> <span class='id identifier rubyid_source'>source</span>
   <span class='id identifier rubyid_move_by'>move_by</span>        <span class='id identifier rubyid_right_by'>right_by</span><span class='comma'>,</span> <span class='id identifier rubyid_down_by'>down_by</span>
   <span class='id identifier rubyid_release'>release</span>

   <span class='kw'>self</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="key_down-instance_method">

     - (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>) <strong>key_down</strong>(*args)


 </h3><div class="docstring">
   <div class="discussion">

 <p>Performs a modifier key press. Does not release the modifier key -
 subsequent interactions may assume it's kept pressed. Note that the
 modifier key is never released implicitly - either #key_up(key) or
 #send_keys(:null) must be called to release the modifier.</p>

 <p>Equivalent to:</p>

 <pre class="code ruby"><code><span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_click'>click</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_send_keys'>send_keys</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
 <span class='comment'># or
 </span><span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_click'>click</span><span class='period'>.</span><span class='id identifier rubyid_send_keys'>send_keys</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span></code></pre>


   </div>
 </div>
 <div class="tags">

   <div class="examples">
     <p class="tag_title">Examples:</p>


         <p class="example_title"><div class='inline'>
 <p>Press a key</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_key_down'>key_down</span><span class='lparen'>(</span><span class='symbol'>:control</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>


         <p class="example_title"><div class='inline'>
 <p>Press a key on an element</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_el'>el</span> <span class='op'>=</span> <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>some_id</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_key_down'>key_down</span><span class='lparen'>(</span><span class='id identifier rubyid_el'>el</span><span class='comma'>,</span> <span class='symbol'>:shift</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>

   </div>
 <p class="tag_title">Parameters:</p>
 <ul class="param">

     <li>

         <span class='name'>The</span>


         <span class='type'>(<tt>:shift</tt>, <tt>:alt</tt>, <tt>:control</tt>, <tt>:command</tt>, <tt>:meta</tt>)</span>


         &mdash;
         <div class='inline'>
 <p>key to press.</p>
 </div>

     </li>

     <li>

         <span class='name'>element</span>


         <span class='type'>(<tt><span class='object_link'><a href="Element.html" title="Selenium::WebDriver::Element (class)">Selenium::WebDriver::Element</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>An optional element</p>
 </div>

     </li>

 </ul>

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>A self reference.</p>
 </div>

     </li>

 </ul>
 <p class="tag_title">Raises:</p>
 <ul class="raise">

     <li>


         <span class='type'>(<tt>ArgumentError</tt>)</span>


         &mdash;
         <div class='inline'>
 <p>if the given key is not a modifier</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 63
 64
 65
 66
 67
 68
 69
 70</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 63</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_key_down'>key_down</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span> <span class='const'>Element</span>
     <span class='ivar'>@actions</span> <span class='op'>&lt;&lt;</span> <span class='lbracket'>[</span><span class='symbol'>:mouse</span><span class='comma'>,</span> <span class='symbol'>:click</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
   <span class='kw'>end</span>

   <span class='ivar'>@actions</span> <span class='op'>&lt;&lt;</span> <span class='lbracket'>[</span><span class='symbol'>:keyboard</span><span class='comma'>,</span> <span class='symbol'>:press</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='rbracket'>]</span>
   <span class='kw'>self</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="key_up-instance_method">

     - (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>) <strong>key_up</strong>(*args)


 </h3><div class="docstring">
   <div class="discussion">

 <p>Performs a modifier key release. Releasing a non-depressed modifier key
 will yield undefined behaviour.</p>


   </div>
 </div>
 <div class="tags">

   <div class="examples">
     <p class="tag_title">Examples:</p>


         <p class="example_title"><div class='inline'>
 <p>Release a key</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_key_up'>key_up</span><span class='lparen'>(</span><span class='symbol'>:shift</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>


         <p class="example_title"><div class='inline'>
 <p>Release a key from an element</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_el'>el</span> <span class='op'>=</span> <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>some_id</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_key_up'>key_up</span><span class='lparen'>(</span><span class='id identifier rubyid_el'>el</span><span class='comma'>,</span> <span class='symbol'>:alt</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>

   </div>
 <p class="tag_title">Parameters:</p>
 <ul class="param">

     <li>

         <span class='name'>The</span>


         <span class='type'>(<tt>:shift</tt>, <tt>:alt</tt>, <tt>:control</tt>, <tt>:command</tt>, <tt>:meta</tt>)</span>


         &mdash;
         <div class='inline'>
 <p>modifier key to release.</p>
 </div>

     </li>

     <li>

         <span class='name'>element</span>


         <span class='type'>(<tt><span class='object_link'><a href="Element.html" title="Selenium::WebDriver::Element (class)">Selenium::WebDriver::Element</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>An optional element</p>
 </div>

     </li>

 </ul>

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>A self reference.</p>
 </div>

     </li>

 </ul>
 <p class="tag_title">Raises:</p>
 <ul class="raise">

     <li>


         <span class='type'>(<tt>ArgumentError</tt>)</span>


         &mdash;
         <div class='inline'>
 <p>if the given key is not a modifier key</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 91
 92
 93
 94
 95
 96
 97
 98</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 91</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_key_up'>key_up</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span> <span class='const'>Element</span>
     <span class='ivar'>@actions</span> <span class='op'>&lt;&lt;</span> <span class='lbracket'>[</span><span class='symbol'>:mouse</span><span class='comma'>,</span> <span class='symbol'>:click</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
   <span class='kw'>end</span>

   <span class='ivar'>@actions</span> <span class='op'>&lt;&lt;</span> <span class='lbracket'>[</span><span class='symbol'>:keyboard</span><span class='comma'>,</span> <span class='symbol'>:release</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='rbracket'>]</span>
   <span class='kw'>self</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="move_by-instance_method">

     - (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>) <strong>move_by</strong>(right_by, down_by)


 </h3><div class="docstring">
   <div class="discussion">

 <p>Moves the mouse from its current position (or 0,0) by the given offset. If
 the coordinates provided are outside the viewport (the mouse will end up
 outside the browser window) then the viewport is scrolled to match.</p>


   </div>
 </div>
 <div class="tags">

   <div class="examples">
     <p class="tag_title">Examples:</p>


         <p class="example_title"><div class='inline'>
 <p>Move the mouse to a certain offset from its current position</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_move_by'>move_by</span><span class='lparen'>(</span><span class='int'>100</span><span class='comma'>,</span> <span class='int'>100</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>

   </div>
 <p class="tag_title">Parameters:</p>
 <ul class="param">

     <li>

         <span class='name'>right_by</span>


         <span class='type'>(<tt>Integer</tt>)</span>


         &mdash;
         <div class='inline'>
 <p>horizontal offset. A negative value means moving the mouse left.</p>
 </div>

     </li>

     <li>

         <span class='name'>down_by</span>


         <span class='type'>(<tt>Integer</tt>)</span>


         &mdash;
         <div class='inline'>
 <p>vertical offset. A negative value means moving the mouse up.</p>
 </div>

     </li>

 </ul>

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>A self reference.</p>
 </div>

     </li>

 </ul>
 <p class="tag_title">Raises:</p>
 <ul class="raise">

     <li>


         <span class='type'>(<tt>MoveTargetOutOfBoundsError</tt>)</span>


         &mdash;
         <div class='inline'>
 <p>if the provided offset is outside the document's boundaries.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 264
 265
 266
 267</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 264</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_move_by'>move_by</span><span class='lparen'>(</span><span class='id identifier rubyid_right_by'>right_by</span><span class='comma'>,</span> <span class='id identifier rubyid_down_by'>down_by</span><span class='rparen'>)</span>
   <span class='ivar'>@actions</span> <span class='op'>&lt;&lt;</span> <span class='lbracket'>[</span><span class='symbol'>:mouse</span><span class='comma'>,</span> <span class='symbol'>:move_by</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_right_by'>right_by</span><span class='comma'>,</span> <span class='id identifier rubyid_down_by'>down_by</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
   <span class='kw'>self</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="move_to-instance_method">

     - (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>) <strong>move_to</strong>(element, right_by = nil, down_by = nil)


 </h3><div class="docstring">
   <div class="discussion">

 <p>Moves the mouse to the middle of the given element. The element is scrolled
 into view and its location is calculated using getBoundingClientRect.  Then
 the mouse is moved to optional offset coordinates from the element.</p>

 <p>Note that when using offsets, both coordinates need to be passed.</p>


   </div>
 </div>
 <div class="tags">

   <div class="examples">
     <p class="tag_title">Examples:</p>


         <p class="example_title"><div class='inline'>
 <p>Scroll element into view and move the mouse to it</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_el'>el</span> <span class='op'>=</span> <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>some_id</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_move_to'>move_to</span><span class='lparen'>(</span><span class='id identifier rubyid_el'>el</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>


       <pre class="example code">
 <span class='id identifier rubyid_el'>el</span> <span class='op'>=</span> <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>some_id</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_move_to'>move_to</span><span class='lparen'>(</span><span class='id identifier rubyid_el'>el</span><span class='comma'>,</span> <span class='int'>100</span><span class='comma'>,</span> <span class='int'>100</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>

   </div>
 <p class="tag_title">Parameters:</p>
 <ul class="param">

     <li>

         <span class='name'>element</span>


         <span class='type'>(<tt><span class='object_link'><a href="Element.html" title="Selenium::WebDriver::Element (class)">Selenium::WebDriver::Element</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>to move to.</p>
 </div>

     </li>

     <li>

         <span class='name'>right_by</span>


         <span class='type'>(<tt>Integer</tt>)</span>


         <em class="default">(defaults to: <tt>nil</tt>)</em>


         &mdash;
         <div class='inline'>
 <p>Optional offset from the top-left corner. A negative value means
 coordinates right from the element.</p>
 </div>

     </li>

     <li>

         <span class='name'>down_by</span>


         <span class='type'>(<tt>Integer</tt>)</span>


         <em class="default">(defaults to: <tt>nil</tt>)</em>


         &mdash;
         <div class='inline'>
 <p>Optional offset from the top-left corner. A negative value means
 coordinates above the element.</p>
 </div>

     </li>

 </ul>

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>A self reference.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 235
 236
 237
 238
 239
 240
 241
 242
 243</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 235</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_move_to'>move_to</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='comma'>,</span> <span class='id identifier rubyid_right_by'>right_by</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_down_by'>down_by</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='id identifier rubyid_right_by'>right_by</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_down_by'>down_by</span>
     <span class='ivar'>@actions</span> <span class='op'>&lt;&lt;</span> <span class='lbracket'>[</span><span class='symbol'>:mouse</span><span class='comma'>,</span> <span class='symbol'>:move_to</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_element'>element</span><span class='comma'>,</span> <span class='id identifier rubyid_right_by'>right_by</span><span class='comma'>,</span> <span class='id identifier rubyid_down_by'>down_by</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
   <span class='kw'>else</span>
     <span class='ivar'>@actions</span> <span class='op'>&lt;&lt;</span> <span class='lbracket'>[</span><span class='symbol'>:mouse</span><span class='comma'>,</span> <span class='symbol'>:move_to</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_element'>element</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
   <span class='kw'>end</span>

   <span class='kw'>self</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="perform-instance_method">

     - (<tt>Object</tt>) <strong>perform</strong>


 </h3><div class="docstring">
   <div class="discussion">

 <p>Executes the actions added to the builder.</p>


   </div>
 </div>
 <div class="tags">


 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 342
 343
 344
 345
 346
 347
 348</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 342</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_perform'>perform</span>
   <span class='ivar'>@actions</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_receiver'>receiver</span><span class='comma'>,</span> <span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='op'>|</span>
     <span class='ivar'>@devices</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_receiver'>receiver</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid___send__'>__send__</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='rbrace'>}</span>

   <span class='kw'>nil</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="release-instance_method">

     - (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>) <strong>release</strong>(element = nil)


 </h3><div class="docstring">
   <div class="discussion">

 <p>Releases the depressed left mouse button at the current mouse location.</p>


   </div>
 </div>
 <div class="tags">

   <div class="examples">
     <p class="tag_title">Examples:</p>


         <p class="example_title"><div class='inline'>
 <p>Releasing an element after clicking and holding it</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_el'>el</span> <span class='op'>=</span> <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>some_id</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_click_and_hold'>click_and_hold</span><span class='lparen'>(</span><span class='id identifier rubyid_el'>el</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_release'>release</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>

   </div>

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>A self reference.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 161
 162
 163
 164</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 161</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_release'>release</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='ivar'>@actions</span> <span class='op'>&lt;&lt;</span> <span class='lbracket'>[</span><span class='symbol'>:mouse</span><span class='comma'>,</span> <span class='symbol'>:up</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_element'>element</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
   <span class='kw'>self</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="send_keys-instance_method">

     - (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>) <strong>send_keys</strong>(*args)


 </h3><div class="docstring">
   <div class="discussion">

 <p>Sends keys to the active element. This differs from calling
 Element#send_keys(keys) on the active element in two ways:</p>
 <ul><li>
 <p>The modifier keys included in this call are not released.</p>
 </li><li>
 <p>There is no attempt to re-focus the element - so send_keys(:tab) for
 switching elements should work.</p>
 </li></ul>


   </div>
 </div>
 <div class="tags">

   <div class="examples">
     <p class="tag_title">Examples:</p>


         <p class="example_title"><div class='inline'>
 <p>Send the text "help" to an element</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_el'>el</span> <span class='op'>=</span> <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='symbol'>:id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>some_id</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_send_keys'>send_keys</span><span class='lparen'>(</span><span class='id identifier rubyid_el'>el</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>help</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>


         <p class="example_title"><div class='inline'>
 <p>Send the text "help" to the currently focused element</p>
 </div></p>

       <pre class="example code">
 <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='period'>.</span><span class='id identifier rubyid_send_keys'>send_keys</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>help</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform'>perform</span></pre>

   </div>
 <p class="tag_title">Parameters:</p>
 <ul class="param">

     <li>

         <span class='name'>element</span>


         <span class='type'>(<tt><span class='object_link'><a href="Element.html" title="Selenium::WebDriver::Element (class)">Selenium::WebDriver::Element</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>An optional element</p>
 </div>

     </li>

     <li>

         <span class='name'>keys</span>


         <span class='type'>(<tt><span class='object_link'><a href="../../String.html" title="String (class)">String</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>The keys to be sent.</p>
 </div>

     </li>

 </ul>

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt><span class='object_link'><a href="" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></tt>)</span>


         &mdash;
         <div class='inline'>
 <p>A self reference.</p>
 </div>

     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 121
 122
 123
 124
 125
 126
 127
 128</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 121</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_send_keys'>send_keys</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span> <span class='const'>Element</span>
     <span class='ivar'>@actions</span> <span class='op'>&lt;&lt;</span> <span class='lbracket'>[</span><span class='symbol'>:mouse</span><span class='comma'>,</span> <span class='symbol'>:click</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
   <span class='kw'>end</span>

   <span class='ivar'>@actions</span> <span class='op'>&lt;&lt;</span> <span class='lbracket'>[</span><span class='symbol'>:keyboard</span><span class='comma'>,</span> <span class='symbol'>:send_keys</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='rbracket'>]</span>
   <span class='kw'>self</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

   </div>

 </div>

     <div id="footer">
   Generated on Thu Jul 19 12:32:31 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.1 (ruby-1.9.3).
 </div>

   </body>
 </html>