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

     &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 (K)</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">Keyboard</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::Keyboard


   <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::Keyboard</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/keyboard.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>Constant Summary</h2>


     <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="#initialize-instance_method" title="#initialize (instance method)">- (Keyboard) <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 Keyboard.</p>
 </div></span>

 </li>


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

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


   </span>


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


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

 </li>


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

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


   </span>


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


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

 </li>


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

       <a href="#send_keys-instance_method" title="#send_keys (instance method)">- (Object) <strong>send_keys</strong>(*keys) </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::Keyboard (class)">Keyboard</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 Keyboard</p>


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


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


 10
 11
 12</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/keyboard.rb', line 10</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="press-instance_method">

     - (<tt>Object</tt>) <strong>press</strong>(key)


 </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>Press a modifier key</p>


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


   <p class="tag_title">See Also:</p>
   <ul class="see">

       <li><span class='object_link'><a href="Keys.html" title="Selenium::WebDriver::Keys (module)">Selenium::WebDriver::Keys</a></span></li>

   </ul>

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


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

 <span class='kw'>def</span> <span class='id identifier rubyid_press'>press</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_assert_modifier'>assert_modifier</span> <span class='id identifier rubyid_key'>key</span>

   <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_sendKeysToActiveElement'>sendKeysToActiveElement</span> <span class='const'>Keys</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>release</strong>(key)


 </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>Release a modifier key</p>


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


   <p class="tag_title">See Also:</p>
   <ul class="see">

       <li><span class='object_link'><a href="Keys.html" title="Selenium::WebDriver::Keys (module)">Selenium::WebDriver::Keys</a></span></li>

   </ul>

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


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

 <span class='kw'>def</span> <span class='id identifier rubyid_release'>release</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_assert_modifier'>assert_modifier</span> <span class='id identifier rubyid_key'>key</span>

   <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_sendKeysToActiveElement'>sendKeysToActiveElement</span> <span class='const'>Keys</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>send_keys</strong>(*keys)


 </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">


 14
 15
 16</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/keyboard.rb', line 14</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_keys'>keys</span><span class='rparen'>)</span>
   <span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_sendKeysToActiveElement'>sendKeysToActiveElement</span> <span class='const'>Keys</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_keys'>keys</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

   </div>

 </div>

     <div id="footer">
   Generated on Thu Jul 19 12:32:30 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>
	<!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::Keyboard

	— 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 (K)</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">Keyboard</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::Keyboard


	<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::Keyboard</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/keyboard.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>Constant Summary</h2>









	<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="#initialize-instance_method" title="#initialize (instance method)">- (Keyboard) <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 Keyboard.</p>
	</div></span>

	</li>


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

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



	</span>






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


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

	</li>


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

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



	</span>






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


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

	</li>


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

	<a href="#send_keys-instance_method" title="#send_keys (instance method)">- (Object) <strong>send_keys</strong>(*keys) </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::Keyboard (class)">Keyboard</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 Keyboard</p>


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


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


	10
	11
	12</pre>
	</td>
	<td>
	<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/keyboard.rb', line 10</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="press-instance_method">

	- (<tt>Object</tt>) <strong>press</strong>(key)





	</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>Press a modifier key</p>


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


	<p class="tag_title">See Also:</p>
	<ul class="see">

	<li><span class='object_link'><a href="Keys.html" title="Selenium::WebDriver::Keys (module)">Selenium::WebDriver::Keys</a></span></li>

	</ul>

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


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

	<span class='kw'>def</span> <span class='id identifier rubyid_press'>press</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
	<span class='id identifier rubyid_assert_modifier'>assert_modifier</span> <span class='id identifier rubyid_key'>key</span>

	<span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_sendKeysToActiveElement'>sendKeysToActiveElement</span> <span class='const'>Keys</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span><span class='rparen'>)</span>
	<span class='kw'>end</span></pre>
	</td>
	</tr>
	</table>
	</div>

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

	- (<tt>Object</tt>) <strong>release</strong>(key)





	</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>Release a modifier key</p>


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


	<p class="tag_title">See Also:</p>
	<ul class="see">

	<li><span class='object_link'><a href="Keys.html" title="Selenium::WebDriver::Keys (module)">Selenium::WebDriver::Keys</a></span></li>

	</ul>

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


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

	<span class='kw'>def</span> <span class='id identifier rubyid_release'>release</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
	<span class='id identifier rubyid_assert_modifier'>assert_modifier</span> <span class='id identifier rubyid_key'>key</span>

	<span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_sendKeysToActiveElement'>sendKeysToActiveElement</span> <span class='const'>Keys</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span><span class='rparen'>)</span>
	<span class='kw'>end</span></pre>
	</td>
	</tr>
	</table>
	</div>

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

	- (<tt>Object</tt>) <strong>send_keys</strong>(*keys)





	</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">


	14
	15
	16</pre>
	</td>
	<td>
	<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/keyboard.rb', line 14</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_keys'>keys</span><span class='rparen'>)</span>
	<span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_sendKeysToActiveElement'>sendKeysToActiveElement</span> <span class='const'>Keys</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_keys'>keys</span><span class='rparen'>)</span>
	<span class='kw'>end</span></pre>
	</td>
	</tr>
	</table>
	</div>

	</div>

	</div>

	<div id="footer">
	Generated on Thu Jul 19 12:32:30 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>