Google Git
Sign in
chromium / external / selenium / refs/heads/master / . / docs / api / rb / Selenium / WebDriver / Window.html
blob: 4d214934ba652ac40c0c58a0c1675d3a8a5a1efe [file] [log] [blame] [edit]
<!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::Window
&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 (W)</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">Window</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::Window
</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::Window</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/window.rb</dd>
</dl>
<div class="clear"></div>
<div class="docstring">
<div class="discussion">
</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="#initialize-instance_method" title="#initialize (instance method)">- (Window) <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 Window.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#maximize-instance_method" title="#maximize (instance method)">- (Object) <strong>maximize</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Maximize the current window.</p>
</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>(x, y) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Equivalent to #position=, but accepts x and y arguments.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#position-instance_method" title="#position (instance method)">- (Selenium::WebDriver::Point) <strong>position</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Get the position of the current window.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#position%3D-instance_method" title="#position= (instance method)">- (Object) <strong>position=</strong>(point) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Move the current window to the given position.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#resize_to-instance_method" title="#resize_to (instance method)">- (Object) <strong>resize_to</strong>(width, height) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Equivalent to #size=, but accepts width and height arguments.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#size-instance_method" title="#size (instance method)">- (Selenium::WebDriver::Dimension) <strong>size</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Get the size of the current window.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#size%3D-instance_method" title="#size= (instance method)">- (Object) <strong>size=</strong>(dimension) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Resize the current window to the given dimension.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::Window (class)">Window</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 Window</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/window.rb', line 14</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="maximize-instance_method">
- (<tt>Object</tt>) <strong>maximize</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Maximize the current window</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
97
98
99</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/window.rb', line 97</span>
<span class='kw'>def</span> <span class='id identifier rubyid_maximize'>maximize</span>
<span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_maximizeWindow'>maximizeWindow</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>(x, y)
</h3><div class="docstring">
<div class="discussion">
<p>Equivalent to #position=, but accepts x and y arguments.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<pre class="example code">
<span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_manage'>manage</span><span class='period'>.</span><span class='id identifier rubyid_window'>window</span><span class='period'>.</span><span class='id identifier rubyid_move_to'>move_to</span><span class='lparen'>(</span><span class='int'>300</span><span class='comma'>,</span> <span class='int'>400</span><span class='rparen'>)</span></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
89
90
91</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/window.rb', line 89</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_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span><span class='rparen'>)</span>
<span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_setWindowPosition'>setWindowPosition</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_y'>y</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="position-instance_method">
- (<tt><span class='object_link'><a href="Point.html" title="Selenium::WebDriver::Point (class)">Selenium::WebDriver::Point</a></span></tt>) <strong>position</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Get the position of the current window.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Point.html" title="Selenium::WebDriver::Point (class)">Selenium::WebDriver::Point</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>The position.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
64
65
66</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/window.rb', line 64</span>
<span class='kw'>def</span> <span class='id identifier rubyid_position'>position</span>
<span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_getWindowPosition'>getWindowPosition</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="position=-instance_method">
- (<tt>Object</tt>) <strong>position=</strong>(point)
</h3><div class="docstring">
<div class="discussion">
<p>Move the current window to the given position.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>point</span>
<span class='type'>(<tt><span class='object_link'><a href="Point.html" title="Selenium::WebDriver::Point (class)">Selenium::WebDriver::Point</a></span></tt>, <tt>#x and #y</tt>)</span>
&mdash;
<div class='inline'>
<p>The new position.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
49
50
51
52
53
54
55
56</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/window.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_position='>position=</span><span class='lparen'>(</span><span class='id identifier rubyid_point'>point</span><span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_point'>point</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:x</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_point'>point</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:y</span><span class='rparen'>)</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 </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_point'>point</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_point'>point</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='op'>+</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> to respond to #x and #y</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_setWindowPosition'>setWindowPosition</span> <span class='id identifier rubyid_point'>point</span><span class='period'>.</span><span class='id identifier rubyid_x'>x</span><span class='comma'>,</span> <span class='id identifier rubyid_point'>point</span><span class='period'>.</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="resize_to-instance_method">
- (<tt>Object</tt>) <strong>resize_to</strong>(width, height)
</h3><div class="docstring">
<div class="discussion">
<p>Equivalent to #size=, but accepts width and height arguments.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'>
<p>Maximize the window.</p>
</div></p>
<pre class="example code">
<span class='id identifier rubyid_max_width'>max_width</span><span class='comma'>,</span> <span class='id identifier rubyid_max_height'>max_height</span> <span class='op'>=</span> <span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_execute_script'>execute_script</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>return [window.screen.availWidth, window.screen.availHeight];</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_driver'>driver</span><span class='period'>.</span><span class='id identifier rubyid_manage'>manage</span><span class='period'>.</span><span class='id identifier rubyid_window'>window</span><span class='period'>.</span><span class='id identifier rubyid_resize_to'>resize_to</span><span class='lparen'>(</span><span class='id identifier rubyid_max_width'>max_width</span><span class='comma'>,</span> <span class='id identifier rubyid_max_height'>max_height</span><span class='rparen'>)</span></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
77
78
79</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/window.rb', line 77</span>
<span class='kw'>def</span> <span class='id identifier rubyid_resize_to'>resize_to</span><span class='lparen'>(</span><span class='id identifier rubyid_width'>width</span><span class='comma'>,</span> <span class='id identifier rubyid_height'>height</span><span class='rparen'>)</span>
<span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_setWindowSize'>setWindowSize</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_width'>width</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_height'>height</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="size-instance_method">
- (<tt><span class='object_link'><a href="Dimension.html" title="Selenium::WebDriver::Dimension (class)">Selenium::WebDriver::Dimension</a></span></tt>) <strong>size</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Get the size of the current window.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Dimension.html" title="Selenium::WebDriver::Dimension (class)">Selenium::WebDriver::Dimension</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>The size.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/window.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_size'>size</span>
<span class='ivar'>@bridge</span><span class='period'>.</span><span class='id identifier rubyid_getWindowSize'>getWindowSize</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="size=-instance_method">
- (<tt>Object</tt>) <strong>size=</strong>(dimension)
</h3><div class="docstring">
<div class="discussion">
<p>Resize the current window to the given dimension.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>dimension</span>
<span class='type'>(<tt><span class='object_link'><a href="Dimension.html" title="Selenium::WebDriver::Dimension (class)">Selenium::WebDriver::Dimension</a></span></tt>, <tt>#width and #height</tt>)</span>
&mdash;
<div class='inline'>
<p>The new size.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24
25
26
27
28
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/window.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_size='>size=</span><span class='lparen'>(</span><span class='id identifier rubyid_dimension'>dimension</span><span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_dimension'>dimension</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:width</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_dimension'>dimension</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:height</span><span class='rparen'>)</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 </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_dimension'>dimension</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_dimension'>dimension</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='op'>+</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> to respond to #width and #height</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_setWindowSize'>setWindowSize</span> <span class='id identifier rubyid_dimension'>dimension</span><span class='period'>.</span><span class='id identifier rubyid_width'>width</span><span class='comma'>,</span> <span class='id identifier rubyid_dimension'>dimension</span><span class='period'>.</span><span class='id identifier rubyid_height'>height</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Jul 19 12:32:27 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>