Class: RAutomation::Window

Inherits:
Object
  • Object
show all
Includes:
Adapter::Helper
Defined in:
lib/rautomation/window.rb

Constant Summary collapse

@@wait_timeout =

Timeout for waiting until object exists. If the timeout exceeds then an RAutomation::WaitHelper::TimeoutError is raised.

60

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(locators) ⇒ Window

Note:

Refer to all possible locators in each Adapter documentation.

Note:

This constructor doesn’t check for window’s existance.

Note:

Only visible windows are supported.

Note:

If given locators include :hwnd then every other possible locator is ignored.

Creates the window object.

Possible window locators may depend of the used platform and adapter, but following examples will use :title, :class and :hwnd.

locators may also include a key called :adapter to change default adapter, which is dependent of the platform, to automate windows and their controls.

It is also possible to change the default adapter by using environment variable called RAUTOMATION_ADAPTER

Examples:

Use window with some title:

RAutomation::Window.new(:title => "some title")

Use window with Regexp title:

RAutomation::Window.new(:title => /some title/i)

Use window with handle (hwnd):

RAutomation::Window.new(:hwnd => 123456)

Use multiple locators, every locator will be matched (AND-ed) to the window:

RAutomation::Window.new(:title => "some title", :class => "IEFrame")

Parameters:

  • locators (Hash) —

    locators for the window.



64
65
66
67
 
# File 'lib/rautomation/window.rb', line 64

def initialize(locators)
  @adapter = locators.delete(:adapter) || ENV["RAUTOMATION_ADAPTER"] && ENV["RAUTOMATION_ADAPTER"].to_sym || default_adapter
  @window = Adapter.const_get(normalize(@adapter)).const_get(:Window).new(locators)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args)

Allows to execute specific Adapter methods not part of the public API.



211
212
213
 
# File 'lib/rautomation/window.rb', line 211

def method_missing(name, *args)
  @window.send(name, *args)
end

Instance Attribute Details

#adapter (readonly)

Currently used Adapter.



33
34
35
 
# File 'lib/rautomation/window.rb', line 33

def adapter
  @adapter
end

Class Method Details

.wait_timeout ⇒ Fixnum

Retrieve current timeout in seconds to wait before RAutomation::WaitHelper::TimeoutError is raised.

Returns:

  • (Fixnum) —

    timeout in seconds



81
82
83
 
# File 'lib/rautomation/window.rb', line 81

def wait_timeout
  @@wait_timeout
end

.wait_timeout=(timeout)

Change the timeout to wait before RAutomation::WaitHelper::TimeoutError is raised.

Parameters:

  • timeout (Fixnum) —

    in seconds.



75
76
77
 
# File 'lib/rautomation/window.rb', line 75

def wait_timeout=(timeout)
  @@wait_timeout = timeout
end

.windows ⇒ Windows

Returns all windows.

Returns:

  • (Windows) —

    all windows.



19
20
21
 
# File 'lib/rautomation/window.rb', line 19

def windows
  Windows.new(nil, {})
end

Instance Method Details

#activate

Activates the Window, e.g. brings it to the top of other windows.



109
110
111
 
# File 'lib/rautomation/window.rb', line 109

def activate
  @window.activate
end

#active? ⇒ Boolean

Checks if the window is active, e.g. on the top of other windows.

Returns:

  • (Boolean) —

    true if the window is active, false otherwise.



115
116
117
 
# File 'lib/rautomation/window.rb', line 115

def active?
  @window.active?
end

#button(locators)

Note:

Refer to specific Adapter documentation for possible locator parameters.

Retrieves Button on the window.

Parameters:

  • locators (Hash) —

    for the Button.

Raises:



197
198
199
200
 
# File 'lib/rautomation/window.rb', line 197

def button(locators)
  wait_until_present
  Button.new(@window, locators)
end

#close

Closes the window if it exists.



188
189
190
191
 
# File 'lib/rautomation/window.rb', line 188

def close
  return unless @window.exists?
  @window.close
end

#exists? ⇒ Boolean Also known as: exist?

Checks if the window exists (does have to be visible).

Returns:

  • (Boolean) —

    true if the window exists, false otherwise.



129
130
131
 
# File 'lib/rautomation/window.rb', line 129

def exists?
  @window.exists?
end

#hwnd ⇒ Fixnum

Returns handle of the window which is used internally for other methods.

Returns:

  • (Fixnum) —

    handle of the window which is used internally for other methods.

Raises:



89
90
91
92
 
# File 'lib/rautomation/window.rb', line 89

def hwnd
  wait_until_present
  @window.hwnd
end

#maximize

Maximizes the window.

Raises:



152
153
154
155
 
# File 'lib/rautomation/window.rb', line 152

def maximize
  wait_until_present
  @window.maximize
end

#minimize

Minimizes the window.

Raises:



159
160
161
162
 
# File 'lib/rautomation/window.rb', line 159

def minimize
  wait_until_present
  @window.minimize
end

#minimized? ⇒ Boolean

Checks if window is minimized.

Returns:

  • (Boolean) —

    true if window is minimized, false otherwise.

Raises:



167
168
169
170
 
# File 'lib/rautomation/window.rb', line 167

def minimized?
  wait_until_present
  @window.minimized?
end

#pid ⇒ Fixnum

Returns process identifier (PID) of the window.

Returns:

  • (Fixnum) —

    process identifier (PID) of the window.

Raises:



96
97
98
99
 
# File 'lib/rautomation/window.rb', line 96

def pid
  wait_until_present
  @window.pid
end

#present? ⇒ Boolean

Checks if the window exists and is visible.

Returns:

  • (Boolean) —

    true if window exists and is visible, false otherwise



146
147
148
 
# File 'lib/rautomation/window.rb', line 146

def present?
  exists? && visible?
end

#restore

Note:

If the window is minimized, makes it visible again.

Restores the window size and position.

Raises:



175
176
177
178
 
# File 'lib/rautomation/window.rb', line 175

def restore
  wait_until_present
  @window.restore
end

#send_keys(keys)

Sends keyboard keys to the window. Refer to specific Adapter documentation for all possible values.

Raises:



182
183
184
185
 
# File 'lib/rautomation/window.rb', line 182

def send_keys(keys)
  wait_until_present
  @window.send_keys(keys)
end

#text ⇒ String

Returns visible text of the Window.

Returns:

  • (String) —

    visible text of the window.

Raises:



122
123
124
125
 
# File 'lib/rautomation/window.rb', line 122

def text
  wait_until_present
  @window.text
end

#text_field(locators)

Note:

Refer to specific Adapter documentation for possible locators parameters.

Retrieves TextField on the window.

Raises:



205
206
207
208
 
# File 'lib/rautomation/window.rb', line 205

def text_field(locators)
  wait_until_present
  TextField.new(@window, locators)
end

#title ⇒ String

Returns title of the window.

Returns:

  • (String) —

    title of the window.

Raises:



103
104
105
106
 
# File 'lib/rautomation/window.rb', line 103

def title
  wait_until_present
  @window.title
end

#visible? ⇒ Boolean

Note:

Window is also visible, if it is behind other windows or minimized.

Checks if window is visible.

Returns:

  • (Boolean) —

    true if window is visible, false otherwise.

Raises:



139
140
141
142
 
# File 'lib/rautomation/window.rb', line 139

def visible?
  wait_until_exists
  @window.visible?
end

#windows(locators = @window.locators) ⇒ Windows

Retrieves all windows with similar locators to the current window.

Parameters:

  • locators (Hash) (defaults to: @window.locators) —

    locators for the window.

Returns:

  • (Windows) —

    all windows matching current window’s locators if no explicit locators specified or windows matching the specified locators.



28
29
30
 
# File 'lib/rautomation/window.rb', line 28

def windows(locators = @window.locators)
  Windows.new(nil, locators)
end