docs/api/rb/Selenium/WebDriver/TouchScreen.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::TouchScreen

     &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 (T)</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">TouchScreen</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::TouchScreen


 </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::TouchScreen</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/touch_screen.rb</dd>

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


   <h2>Constant Summary</h2>

     <dl class="constants">

         <dt id="FLICK_SPEED-constant" class="">FLICK_SPEED =

         </dt>
         <dd><pre class="code"><span class='lbrace'>{</span> <span class='symbol'>:normal</span> <span class='op'>=&gt;</span> <span class='int'>0</span><span class='comma'>,</span> <span class='symbol'>:fast</span> <span class='op'>=&gt;</span> <span class='int'>1</span><span class='rbrace'>}</span></pre></dd>

     </dl>


     <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="#double_tap-instance_method" title="#double_tap (instance method)">- (Object) <strong>double_tap</strong>(element) </a>


   </span>


     <span class="summary_desc"><div class='inline'></div></span>

 </li>


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

       <a href="#down-instance_method" title="#down (instance method)">- (Object) <strong>down</strong>(x, y = nil) </a>


   </span>


     <span class="summary_desc"><div class='inline'></div></span>

 </li>


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

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


   </span>


     <span class="summary_desc"><div class='inline'></div></span>

 </li>


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

       <a href="#initialize-instance_method" title="#initialize (instance method)">- (TouchScreen) <strong>initialize</strong>(bridge) </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 TouchScreen.</p>
 </div></span>

 </li>


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

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


   </span>


     <span class="summary_desc"><div class='inline'></div></span>

 </li>


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

       <a href="#move-instance_method" title="#move (instance method)">- (Object) <strong>move</strong>(x, y = nil) </a>


   </span>


     <span class="summary_desc"><div class='inline'></div></span>

 </li>


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

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


   </span>


     <span class="summary_desc"><div class='inline'></div></span>

 </li>


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

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


   </span>


     <span class="summary_desc"><div class='inline'></div></span>

 </li>


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

       <a href="#up-instance_method" title="#up (instance method)">- (Object) <strong>up</strong>(x, y = nil) </a>


   </span>


     <span class="summary_desc"><div class='inline'></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::TouchScreen (class)">TouchScreen</a></span></tt>) <strong>initialize</strong>(bridge)


 </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 TouchScreen</p>


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


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


 11
 12
 13</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/touch_screen.rb', line 11</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_bridge'>bridge</span><span class='rparen'>)</span>
   <span class='ivar'>@bridge</span> <span class='op'>=</span> <span class='id identifier rubyid_bridge'>bridge</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="double_tap-instance_method">

     - (<tt>Object</tt>) <strong>double_tap</strong>(element)


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


 20
 21
 22
 23</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/touch_screen.rb', line 20</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_double_tap'>double_tap</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_assert_element'>assert_element</span> <span class='id identifier rubyid_element'>element</span>
   <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_touchDoubleTap'>touchDoubleTap</span> <span class='id identifier rubyid_element'>element</span><span class='period'>.</span><span class='id identifier rubyid_ref'>ref</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>down</strong>(x, y = nil)


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


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

 <span class='kw'>def</span> <span class='id identifier rubyid_down'>down</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span> <span class='op'>=</span> <span class='id identifier rubyid_coords_from'>coords_from</span> <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span>
   <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_touchDown'>touchDown</span> <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>flick</strong>(*args)


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


 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/touch_screen.rb', line 59</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_flick'>flick</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='kw'>case</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span>
   <span class='kw'>when</span> <span class='int'>2</span>
     <span class='id identifier rubyid_x_speed'>x_speed</span><span class='comma'>,</span> <span class='id identifier rubyid_y_speed'>y_speed</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span>
     <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_touchFlick'>touchFlick</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_x_speed'>x_speed</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_y_speed'>y_speed</span><span class='rparen'>)</span>
   <span class='kw'>when</span> <span class='int'>4</span>
     <span class='id identifier rubyid_element'>element</span><span class='comma'>,</span> <span class='id identifier rubyid_xoffset'>xoffset</span><span class='comma'>,</span> <span class='id identifier rubyid_yoffset'>yoffset</span><span class='comma'>,</span> <span class='id identifier rubyid_speed'>speed</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span>

     <span class='id identifier rubyid_assert_element'>assert_element</span> <span class='id identifier rubyid_element'>element</span>
     <span class='id identifier rubyid_flick_speed'>flick_speed</span> <span class='op'>=</span> <span class='const'>FLICK_SPEED</span><span class='lbracket'>[</span><span class='id identifier rubyid_speed'>speed</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span>

     <span class='kw'>unless</span> <span class='id identifier rubyid_flick_speed'>flick_speed</span>
       <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>expected one of </span><span class='embexpr_beg'>#{</span><span class='const'>FLICK_SPEED</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='rbrace'>}</span><span class='tstring_content'>, got </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_speed'>speed</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
     <span class='kw'>end</span>

     <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_touchElementFlick'>touchElementFlick</span> <span class='id identifier rubyid_element'>element</span><span class='period'>.</span><span class='id identifier rubyid_ref'>ref</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_xoffset'>xoffset</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_yoffset'>yoffset</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_flick_speed'>flick_speed</span>
   <span class='kw'>else</span>
     <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>wrong number of arguments, expected 2 or 4, got </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
   <span class='kw'>end</span>

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

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

     - (<tt>Object</tt>) <strong>long_press</strong>(element)


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


 25
 26
 27
 28</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/touch_screen.rb', line 25</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_long_press'>long_press</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_assert_element'>assert_element</span> <span class='id identifier rubyid_element'>element</span>
   <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_touchLongPress'>touchLongPress</span> <span class='id identifier rubyid_element'>element</span><span class='period'>.</span><span class='id identifier rubyid_ref'>ref</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>move</strong>(x, y = nil)


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


 40
 41
 42
 43</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/touch_screen.rb', line 40</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_move'>move</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span> <span class='op'>=</span> <span class='id identifier rubyid_coords_from'>coords_from</span> <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span>
   <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_touchMove'>touchMove</span> <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>scroll</strong>(*args)


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


 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/touch_screen.rb', line 45</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_scroll'>scroll</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='kw'>case</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span>
   <span class='kw'>when</span> <span class='int'>2</span>
     <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span>
     <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_touchScroll'>touchScroll</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span>
   <span class='kw'>when</span> <span class='int'>3</span>
     <span class='id identifier rubyid_element'>element</span><span class='comma'>,</span> <span class='id identifier rubyid_x_offset'>x_offset</span><span class='comma'>,</span> <span class='id identifier rubyid_y_offset'>y_offset</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span>
     <span class='id identifier rubyid_assert_element'>assert_element</span> <span class='id identifier rubyid_element'>element</span>
     <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_touchScroll'>touchScroll</span> <span class='id identifier rubyid_element'>element</span><span class='period'>.</span><span class='id identifier rubyid_ref'>ref</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_x_offset'>x_offset</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_y_offset'>y_offset</span><span class='rparen'>)</span>
   <span class='kw'>else</span>
     <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>wrong number of arguments, expected 2..3, got </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
   <span class='kw'>end</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>single_tap</strong>(element)


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


 15
 16
 17
 18</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/touch_screen.rb', line 15</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_single_tap'>single_tap</span><span class='lparen'>(</span><span class='id identifier rubyid_element'>element</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_assert_element'>assert_element</span> <span class='id identifier rubyid_element'>element</span>
   <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_touchSingleTap'>touchSingleTap</span> <span class='id identifier rubyid_element'>element</span><span class='period'>.</span><span class='id identifier rubyid_ref'>ref</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>up</strong>(x, y = nil)


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


 35
 36
 37
 38</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/touch_screen.rb', line 35</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_up'>up</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span> <span class='op'>=</span> <span class='id identifier rubyid_coords_from'>coords_from</span> <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span>
   <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_touchUp'>touchUp</span> <span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</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>