| <!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::Mouse |
| |
| — 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 (M)</a> » |
| <span class='title'><span class='object_link'><a href="../../Selenium.html" title="Selenium (module)">Selenium</a></span></span> » <span class='title'><span class='object_link'><a href="../WebDriver.html" title="Selenium::WebDriver (module)">WebDriver</a></span></span> |
| » |
| <span class="title">Mouse</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::Mouse |
| |
| |
| <span class="private note title">Private</span> |
| </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::Mouse</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/mouse.rb</dd> |
| |
| </dl> |
| <div class="clear"></div> |
| |
| <h2>Overview</h2><div class="docstring"> |
| <div class="discussion"> |
| <p class="note private"> |
| <strong>This class is part of a private API.</strong> |
| You should avoid using this class if possible, as it may be removed or be changed in the future. |
| </p> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| <p class="tag_title">See Also:</p> |
| <ul class="see"> |
| |
| <li><span class='object_link'><a href="ActionBuilder.html" title="Selenium::WebDriver::ActionBuilder (class)">ActionBuilder</a></span></li> |
| |
| </ul> |
| |
| </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)">- (Object) <strong>click</strong>(element = nil) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| <span class="private note title">private</span> |
| |
| |
| <span class="summary_desc"><div class='inline'></div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#context_click-instance_method" title="#context_click (instance method)">- (Object) <strong>context_click</strong>(element = nil) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| <span class="private note title">private</span> |
| |
| |
| <span class="summary_desc"><div class='inline'></div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#double_click-instance_method" title="#double_click (instance method)">- (Object) <strong>double_click</strong>(element = nil) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| <span class="private note title">private</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>(element = nil) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| <span class="private note title">private</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)">- (Mouse) <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 Mouse.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#move_by-instance_method" title="#move_by (instance method)">- (Object) <strong>move_by</strong>(right_by, down_by) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| <span class="private note title">private</span> |
| |
| |
| <span class="summary_desc"><div class='inline'></div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#move_to-instance_method" title="#move_to (instance method)">- (Object) <strong>move_to</strong>(element, right_by = nil, down_by = nil) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| <span class="private note title">private</span> |
| |
| |
| <span class="summary_desc"><div class='inline'> |
| <p>Move the mouse.</p> |
| </div></span> |
| |
| </li> |
| |
| |
| <li class="public "> |
| <span class="summary_signature"> |
| |
| <a href="#up-instance_method" title="#up (instance method)">- (Object) <strong>up</strong>(element = nil) </a> |
| |
| |
| |
| </span> |
| |
| |
| |
| |
| |
| |
| <span class="private note title">private</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::Mouse (class)">Mouse</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 Mouse</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/mouse.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="click-instance_method"> |
| |
| - (<tt>Object</tt>) <strong>click</strong>(element = nil) |
| |
| |
| |
| |
| |
| </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> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><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/mouse.rb', line 15</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='id identifier rubyid_move_if_needed'>move_if_needed</span> <span class='id identifier rubyid_element'>element</span> |
| <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_click'>click</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="context_click-instance_method"> |
| |
| - (<tt>Object</tt>) <strong>context_click</strong>(element = nil) |
| |
| |
| |
| |
| |
| </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> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><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/mouse.rb', line 25</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='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span> |
| <span class='id identifier rubyid_move_if_needed'>move_if_needed</span> <span class='id identifier rubyid_element'>element</span> |
| <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_contextClick'>contextClick</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="double_click-instance_method"> |
| |
| - (<tt>Object</tt>) <strong>double_click</strong>(element = nil) |
| |
| |
| |
| |
| |
| </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> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><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/mouse.rb', line 20</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='id identifier rubyid_move_if_needed'>move_if_needed</span> <span class='id identifier rubyid_element'>element</span> |
| <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_doubleClick'>doubleClick</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>(element = nil) |
| |
| |
| |
| |
| |
| </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> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><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/mouse.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_element'>element</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span> |
| <span class='id identifier rubyid_move_if_needed'>move_if_needed</span> <span class='id identifier rubyid_element'>element</span> |
| <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_mouseDown'>mouseDown</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="move_by-instance_method"> |
| |
| - (<tt>Object</tt>) <strong>move_by</strong>(right_by, down_by) |
| |
| |
| |
| |
| |
| </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> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 57 |
| 58 |
| 59</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/mouse.rb', line 57</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'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_mouseMoveTo'>mouseMoveTo</span> <span class='kw'>nil</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='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| <div class="method_details "> |
| <h3 class="signature " id="move_to-instance_method"> |
| |
| - (<tt>Object</tt>) <strong>move_to</strong>(element, right_by = nil, down_by = nil) |
| |
| |
| |
| |
| |
| </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>Move the mouse.</p> |
| |
| <p>Examples:</p> |
| |
| <pre class="code ruby"><code><span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_mouse'>mouse</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='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_mouse'>mouse</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='comma'>,</span> <span class='int'>5</span><span class='comma'>,</span> <span class='int'>5</span><span class='rparen'>)</span></code></pre> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><table class="source_code"> |
| <tr> |
| <td> |
| <pre class="lines"> |
| |
| |
| 49 |
| 50 |
| 51 |
| 52 |
| 53 |
| 54 |
| 55</pre> |
| </td> |
| <td> |
| <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/mouse.rb', line 49</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'>unless</span> <span class='id identifier rubyid_element'>element</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span> <span class='const'>Element</span> |
| <span class='id identifier rubyid_raise'>raise</span> <span class='const'>TypeError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>expected </span><span class='embexpr_beg'>#{</span><span class='const'>Element</span><span class='rbrace'>}</span><span class='tstring_content'>, got </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_element'>element</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='rbrace'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_element'>element</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> |
| <span class='kw'>end</span> |
| |
| <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_mouseMoveTo'>mouseMoveTo</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='id identifier rubyid_right_by'>right_by</span><span class='comma'>,</span> <span class='id identifier rubyid_down_by'>down_by</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>(element = nil) |
| |
| |
| |
| |
| |
| </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> |
| |
| |
| </div> |
| </div> |
| <div class="tags"> |
| |
| |
| </div><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/mouse.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_element'>element</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span> |
| <span class='id identifier rubyid_move_if_needed'>move_if_needed</span> <span class='id identifier rubyid_element'>element</span> |
| <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_mouseUp'>mouseUp</span> |
| <span class='kw'>end</span></pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| </div> |
| |
| </div> |
| |
| <div id="footer"> |
| Generated on Thu Jul 19 12:32:25 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> |
