Class: Watir::Window

Inherits:
Object
  • Object
show all
Includes:
EventuallyPresent
Defined in:
lib/watir-webdriver/window.rb

Instance Method Summary collapse

Methods included from EventuallyPresent

#wait_until_present, #wait_while_present, #when_present

Constructor Details

#initialize(driver, selector) ⇒ Window

Returns a new instance of Window.



5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
# File 'lib/watir-webdriver/window.rb', line 5

def initialize(driver, selector)
  @driver   = driver
  @selector = selector

  if selector.empty?
    @handle = driver.window_handle
  elsif selector.has_key? :handle
    @handle = selector.delete :handle
  else
    unless selector.keys.all? { |k| [:title, :url, :index].include? k }
      raise ArgumentError, "invalid window selector: #{selector.inspect}"
    end
  end
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql?

Returns true if two windows are equal.

Examples:

browser.window(:index => 1) == browser.window(:index => 2)

Parameters:



135
136
137
138
139
 
# File 'lib/watir-webdriver/window.rb', line 135

def ==(other)
  return false unless other.kind_of?(self.class)

  handle == other.handle
end

#close ⇒ Object

CLoses window.



162
163
164
 
# File 'lib/watir-webdriver/window.rb', line 162

def close
  use { @driver.close }
end

#current? ⇒ Boolean

Returns true if window is current.

Examples:

browser.window.current?
#=> true

Returns:

  • (Boolean) 


154
155
156
 
# File 'lib/watir-webdriver/window.rb', line 154

def current?
  @driver.window_handle == handle
end

#exists? ⇒ Boolean

Returns true if window exists.

Returns:

  • (Boolean) 


107
108
109
110
111
112
 
# File 'lib/watir-webdriver/window.rb', line 107

def exists?
  handle
  true
rescue Exception::NoMatchingWindowFoundException
  false
end

#hash ⇒ Object 



142
143
144
 
# File 'lib/watir-webdriver/window.rb', line 142

def hash
  handle.hash ^ self.class.hash
end

#inspect ⇒ Object 



20
21
22
 
# File 'lib/watir-webdriver/window.rb', line 20

def inspect
  '#<%s:0x%x located=%s>' % [self.class, hash*2, !!@handle]
end

#maximize ⇒ Object

Maximizes window.

Examples:

browser.window.maximize


97
98
99
 
# File 'lib/watir-webdriver/window.rb', line 97

def maximize
  use { @driver.manage.window.maximize }
end

#move_to(x, y) ⇒ Object

Moves window to given x and y coordinates.

Examples:

browser.window.move_to 300, 200

Parameters:

  • x (Fixnum)
  • y (Fixnum) 


83
84
85
86
87
88
 
# File 'lib/watir-webdriver/window.rb', line 83

def move_to(x, y)
  point = Selenium::WebDriver::Point.new(x, y)
  use { @driver.manage.window.position = point }

  point
end

#position ⇒ Object

Returns window position.

Examples:

position = browser.window.position
"%sx%s" % [position.x, position.y]
#=> "92x76"


49
50
51
52
53
54
 
# File 'lib/watir-webdriver/window.rb', line 49

def position
  pos = nil
  use { pos = @driver.manage.window.position }

  pos
end

#present? ⇒ Boolean

Returns true if window is present.

Returns:

  • (Boolean) 


120
121
122
123
124
 
# File 'lib/watir-webdriver/window.rb', line 120

def present?
  @handle = nil # relocate

  exists?
end

#resize_to(width, height) ⇒ Object

Resizes window to given width and height.

Examples:

browser.window.resize_to 1600, 1200

Parameters:

  • width (Fixnum)
  • height (Fixnum) 


66
67
68
69
70
71
 
# File 'lib/watir-webdriver/window.rb', line 66

def resize_to(width, height)
  dimension = Selenium::WebDriver::Dimension.new(width, height)
  use { @driver.manage.window.size = dimension }

  dimension
end

#size ⇒ Object

Returns window size.

Examples:

size = browser.window.size
"%sx%s" % [size.width, size.height]
#=> "1600x1200"


33
34
35
36
37
38
 
# File 'lib/watir-webdriver/window.rb', line 33

def size
  size = nil
  use { size = @driver.manage.window.size }

  size
end

#title ⇒ String

Returns window title.

Returns:

  • (String) 


172
173
174
175
176
177
 
# File 'lib/watir-webdriver/window.rb', line 172

def title
  title = nil
  use { title = @driver.title }

  title
end

#url ⇒ String

Returns window URL.

Returns:

  • (String) 


185
186
187
188
189
190
 
# File 'lib/watir-webdriver/window.rb', line 185

def url
  url = nil
  use { url = @driver.current_url }

  url
end

#use(&blk) ⇒ Object

Switches to given window and executes block, then switches back.

Examples:

browser.window(:title => "2nd window").use do
  browser.button(:id => "close").click
end


201
202
203
204
 
# File 'lib/watir-webdriver/window.rb', line 201

def use(&blk)
  @driver.switch_to.window(handle, &blk)
  self
end