docs/api/rb/Selenium/Client/Extensions.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>
   Module: Selenium::Client::Extensions

     &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 (E)</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="../Client.html" title="Selenium::Client (module)">Client</a></span></span>
      &raquo;
     <span class="title">Extensions</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>Module: Selenium::Client::Extensions


 </h1>

 <dl class="box">


     <dt class="r1">Included in:</dt>
     <dd class="r1"><span class='object_link'><a href="Base.html" title="Selenium::Client::Base (module)">Base</a></span></dd>


     <dt class="r2 last">Defined in:</dt>
     <dd class="r2 last">rb/lib/selenium/client/extensions.rb</dd>

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

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

 <p>Convenience methods not explicitely part of the protocol</p>


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


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


   </span>


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

 </li>


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

       <a href="#wait_for_ajax-instance_method" title="#wait_for_ajax (instance method)">- (Object) <strong>wait_for_ajax</strong>(options = {}) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>These for all Ajax request to finish (Only works if you are using
 prototype, the wait happens in the browser).</p>
 </div></span>

 </li>


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

       <a href="#wait_for_effects-instance_method" title="#wait_for_effects (instance method)">- (Object) <strong>wait_for_effects</strong>(options = {}) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Wait for all Prototype effects to be processed (the wait happens in the
 browser).</p>
 </div></span>

 </li>


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

       <a href="#wait_for_element-instance_method" title="#wait_for_element (instance method)">- (Object) <strong>wait_for_element</strong>(locator, options = {}) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Wait for an element to be present (the wait happens in the browser).</p>
 </div></span>

 </li>


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

       <a href="#wait_for_field_value-instance_method" title="#wait_for_field_value (instance method)">- (Object) <strong>wait_for_field_value</strong>(locator, expected_value, options = {}) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Wait for a field to get a specific value (the wait happens in the browser).</p>
 </div></span>

 </li>


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

       <a href="#wait_for_no_element-instance_method" title="#wait_for_no_element (instance method)">- (Object) <strong>wait_for_no_element</strong>(locator, options = {}) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Wait for an element to NOT be present (the wait happens in the browser).</p>
 </div></span>

 </li>


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

       <a href="#wait_for_no_field_value-instance_method" title="#wait_for_no_field_value (instance method)">- (Object) <strong>wait_for_no_field_value</strong>(locator, expected_value, options = {}) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Wait for a field to not have a specific value (the wait happens in the
 browser).</p>
 </div></span>

 </li>


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

       <a href="#wait_for_no_text-instance_method" title="#wait_for_no_text (instance method)">- (Object) <strong>wait_for_no_text</strong>(pattern, options = {}) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Wait for some text to NOT be present (the wait happens in the browser).</p>
 </div></span>

 </li>


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

       <a href="#wait_for_not_visible-instance_method" title="#wait_for_not_visible (instance method)">- (Object) <strong>wait_for_not_visible</strong>(locator, options = {}) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Wait for something to not be visible (the wait happens in the browser).</p>
 </div></span>

 </li>


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

       <a href="#wait_for_text-instance_method" title="#wait_for_text (instance method)">- (Object) <strong>wait_for_text</strong>(pattern, options = {}) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>wait_for_text will search for the given argument within the innerHTML of
 the current DOM.</p>
 </div></span>

 </li>


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

       <a href="#wait_for_visible-instance_method" title="#wait_for_visible (instance method)">- (Object) <strong>wait_for_visible</strong>(locator, options = {}) </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Wait for something to be visible (the wait happens in the browser).</p>
 </div></span>

 </li>


     </ul>


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


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

     - (<tt>Object</tt>) <strong>active_javascript_framework</strong>(options)


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


 111
 112
 113</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/client/extensions.rb', line 111</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_active_javascript_framework'>active_javascript_framework</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:javascript_framework</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_default_javascript_framework'>default_javascript_framework</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>wait_for_ajax</strong>(options = {})


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

 <p>These for all Ajax request to finish (Only works if you are using
 prototype, the wait happens in the browser)</p>

 <p>See <a
 href="http://davidvollbracht.com/2008/6/4/30-days-of-tech-day-3-waitforajax">davidvollbracht.com/2008/6/4/30-days-of-tech-day-3-waitforajax</a>
 for more background.</p>


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


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


 11
 12
 13
 14
 15</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/client/extensions.rb', line 11</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_wait_for_ajax'>wait_for_ajax</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
 <span class='id identifier rubyid_builder'>builder</span> <span class='op'>=</span> <span class='const'>JavascriptExpressionBuilder</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_active_javascript_framework'>active_javascript_framework</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_wait_for_condition'>wait_for_condition</span> <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_no_pending_ajax_requests'>no_pending_ajax_requests</span><span class='period'>.</span><span class='id identifier rubyid_script'>script</span><span class='comma'>,</span>
                     <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:timeout_in_seconds</span><span class='rbracket'>]</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>wait_for_effects</strong>(options = {})


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

 <p>Wait for all Prototype effects to be processed (the wait happens in the
 browser).</p>

 <p>Credits to <a
 href="http://github.com/brynary/webrat/tree/master">github.com/brynary/webrat/tree/master</a></p>


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


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


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

 <span class='kw'>def</span> <span class='id identifier rubyid_wait_for_effects'>wait_for_effects</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
    <span class='id identifier rubyid_builder'>builder</span> <span class='op'>=</span> <span class='const'>JavascriptExpressionBuilder</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_active_javascript_framework'>active_javascript_framework</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_wait_for_condition'>wait_for_condition</span> <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_no_pending_effects'>no_pending_effects</span><span class='period'>.</span><span class='id identifier rubyid_script'>script</span><span class='comma'>,</span>
                      <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:timeout_in_seconds</span><span class='rbracket'>]</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>wait_for_element</strong>(locator, options = {})


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

 <p>Wait for an element to be present (the wait happens in the browser).</p>


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


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


 27
 28
 29
 30
 31</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/client/extensions.rb', line 27</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_wait_for_element'>wait_for_element</span><span class='lparen'>(</span><span class='id identifier rubyid_locator'>locator</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_builder'>builder</span> <span class='op'>=</span> <span class='const'>JavascriptExpressionBuilder</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
   <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='id identifier rubyid_locator'>locator</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_append'>append</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>element != null;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
   <span class='id identifier rubyid_wait_for_condition'>wait_for_condition</span> <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_script'>script</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:timeout_in_seconds</span><span class='rbracket'>]</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>wait_for_field_value</strong>(locator, expected_value, options = {})


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

 <p>Wait for a field to get a specific value (the wait happens in the browser).</p>


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


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


 86
 87
 88
 89
 90</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/client/extensions.rb', line 86</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_wait_for_field_value'>wait_for_field_value</span><span class='lparen'>(</span><span class='id identifier rubyid_locator'>locator</span><span class='comma'>,</span> <span class='id identifier rubyid_expected_value'>expected_value</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_builder'>builder</span> <span class='op'>=</span> <span class='const'>JavascriptExpressionBuilder</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
   <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='id identifier rubyid_locator'>locator</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_element_value_is'>element_value_is</span><span class='lparen'>(</span><span class='id identifier rubyid_expected_value'>expected_value</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_wait_for_condition'>wait_for_condition</span> <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_script'>script</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:timeout_in_seconds</span><span class='rbracket'>]</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>wait_for_no_element</strong>(locator, options = {})


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

 <p>Wait for an element to NOT be present (the wait happens in the browser).</p>


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


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


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

 <span class='kw'>def</span> <span class='id identifier rubyid_wait_for_no_element'>wait_for_no_element</span><span class='lparen'>(</span><span class='id identifier rubyid_locator'>locator</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_builder'>builder</span> <span class='op'>=</span> <span class='const'>JavascriptExpressionBuilder</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
   <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='id identifier rubyid_locator'>locator</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_append'>append</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>element == null;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
   <span class='id identifier rubyid_wait_for_condition'>wait_for_condition</span> <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_script'>script</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:timeout_in_seconds</span><span class='rbracket'>]</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>wait_for_no_field_value</strong>(locator, expected_value, options = {})


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

 <p>Wait for a field to not have a specific value (the wait happens in the
 browser).</p>


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


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


 93
 94
 95
 96
 97</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/client/extensions.rb', line 93</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_wait_for_no_field_value'>wait_for_no_field_value</span><span class='lparen'>(</span><span class='id identifier rubyid_locator'>locator</span><span class='comma'>,</span> <span class='id identifier rubyid_expected_value'>expected_value</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_builder'>builder</span> <span class='op'>=</span> <span class='const'>JavascriptExpressionBuilder</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
   <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_find_element'>find_element</span><span class='lparen'>(</span><span class='id identifier rubyid_locator'>locator</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_element_value_is_not'>element_value_is_not</span><span class='lparen'>(</span><span class='id identifier rubyid_expected_value'>expected_value</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_wait_for_condition'>wait_for_condition</span> <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_script'>script</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:timeout_in_seconds</span><span class='rbracket'>]</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>wait_for_no_text</strong>(pattern, options = {})


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

 <p>Wait for some text to NOT be present (the wait happens in the browser).</p>

 <p>See wait_for_text for usage details.</p>


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


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


 79
 80
 81
 82
 83</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/client/extensions.rb', line 79</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_wait_for_no_text'>wait_for_no_text</span><span class='lparen'>(</span><span class='id identifier rubyid_pattern'>pattern</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_builder'>builder</span> <span class='op'>=</span> <span class='const'>JavascriptExpressionBuilder</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
 <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_find_text'>find_text</span><span class='lparen'>(</span><span class='id identifier rubyid_pattern'>pattern</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_append'>append</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>text_match == false;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
   <span class='id identifier rubyid_wait_for_condition'>wait_for_condition</span> <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_script'>script</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:timeout_in_seconds</span><span class='rbracket'>]</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>wait_for_not_visible</strong>(locator, options = {})


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

 <p>Wait for something to not be visible (the wait happens in the browser).</p>


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


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


 106
 107
 108
 109</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/client/extensions.rb', line 106</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_wait_for_not_visible'>wait_for_not_visible</span><span class='lparen'>(</span><span class='id identifier rubyid_locator'>locator</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_builder'>builder</span> <span class='op'>=</span> <span class='const'>JavascriptExpressionBuilder</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
   <span class='id identifier rubyid_wait_for_condition'>wait_for_condition</span> <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_not_visible'>not_visible</span><span class='lparen'>(</span><span class='id identifier rubyid_locator'>locator</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_script'>script</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:timeout_in_seconds</span><span class='rbracket'>]</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>wait_for_text</strong>(pattern, options = {})


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

 <p>wait_for_text will search for the given argument within the innerHTML of
 the current DOM. Note that this method treats a single string as a special
 case.</p>

 <h4>Parameters</h4>

 <p>wait_for_text accepts an optional hash of parameters:</p>
 <ul><li>
 <p><tt>:element</tt> - a selenium locator for an element limiting the search
 scope.</p>
 </li><li>
 <p><tt>:timeout_in_seconds</tt> - duration in seconds after  which we time out
 if text cannot be found.</p>
 </li></ul>

 <h4>Regular Expressions</h4>

 <p>In addition to plain strings, wait_for_text accepts regular expressions as
 the pattern specification.</p>

 <h4>Examples</h4>

 <p>The following are equivalent, and will match "some text" anywhere within
 the document:</p>

 <pre class="code ruby"><code><span class='id identifier rubyid_wait_for_text'>wait_for_text</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>some text</span><span class='tstring_end'>&quot;</span></span>
 <span class='id identifier rubyid_wait_for_text'>wait_for_text</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>some text</span><span class='regexp_end'>/</span></span></code></pre>

 <p>This will match "some text" anywhere within the specified element:</p>

 <pre class="code ruby"><code><span class='id identifier rubyid_wait_for_text'>wait_for_text</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>some text</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='symbol'>:element</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>container</span><span class='tstring_end'>&quot;</span></span></code></pre>

 <p>This will match "some text" only if it exactly matches the complete
 innerHTML of the specified element:</p>

 <pre class="code ruby"><code><span class='id identifier rubyid_wait_for_text'>wait_for_text</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>some text</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:element</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>container</span><span class='tstring_end'>&quot;</span></span></code></pre>


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


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


 70
 71
 72
 73
 74</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/client/extensions.rb', line 70</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_wait_for_text'>wait_for_text</span><span class='lparen'>(</span><span class='id identifier rubyid_pattern'>pattern</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_builder'>builder</span> <span class='op'>=</span> <span class='const'>JavascriptExpressionBuilder</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
 <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_find_text'>find_text</span><span class='lparen'>(</span><span class='id identifier rubyid_pattern'>pattern</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_append'>append</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>text_match == true;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
   <span class='id identifier rubyid_wait_for_condition'>wait_for_condition</span> <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_script'>script</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:timeout_in_seconds</span><span class='rbracket'>]</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

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

     - (<tt>Object</tt>) <strong>wait_for_visible</strong>(locator, options = {})


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

 <p>Wait for something to be visible (the wait happens in the browser).</p>


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


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


 100
 101
 102
 103</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/client/extensions.rb', line 100</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_wait_for_visible'>wait_for_visible</span><span class='lparen'>(</span><span class='id identifier rubyid_locator'>locator</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_builder'>builder</span> <span class='op'>=</span> <span class='const'>JavascriptExpressionBuilder</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
   <span class='id identifier rubyid_wait_for_condition'>wait_for_condition</span> <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_visible'>visible</span><span class='lparen'>(</span><span class='id identifier rubyid_locator'>locator</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_script'>script</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:timeout_in_seconds</span><span class='rbracket'>]</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

   </div>

 </div>

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