Class: Selenium::WebDriver::ActionBuilder

Inherits:
Object
  • Object
show all
Defined in:
rb/lib/selenium/webdriver/common/action_builder.rb

Overview

The ActionBuilder provides the user a way to set up and perform complex user interactions.

This class should not be instantiated directly, but is created by Selenium::WebDriver::DriverExtensions::HasInputDevices#action, which is available on Driver instances that support the user interaction API.

Examples:

driver.action.key_down(:shift).
              click(element).
              click(second_element).
              key_up(:shift).
              drag_and_drop(element, third_element).
              perform

Direct Known Subclasses

TouchActionBuilder

Instance Method Summary (collapse)

Constructor Details

- (ActionBuilder) initialize(mouse, keyboard)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

A new instance of ActionBuilder



28
29
30
31
32
33
34
35
# File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 28

def initialize(mouse, keyboard)
  @devices    = {
    :mouse    => mouse,
    :keyboard => keyboard
  }

  @actions  = []
end

Instance Method Details

- (ActionBuilder) click(element = nil)

Clicks in the middle of the given element. Equivalent to:

driver.action.move_to(element).click

When no element is passed, the current mouse position will be clicked.

Examples:

Clicking on an element

el = driver.find_element(:id, "some_id")
driver.action.click(el).perform

Clicking at the current mouse position

driver.action.click.perform

Parameters:

Returns:



186
187
188
189
# File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 186

def click(element = nil)
  @actions << [:mouse, :click, [element]]
  self
end

- (ActionBuilder) click_and_hold(element)

Clicks (without releasing) in the middle of the given element. This is equivalent to:

driver.action.move_to(element).click_and_hold

Examples:

Clicking and holding on some element

el = driver.find_element(:id, "some_id")
driver.action.click_and_hold(el).perform

Parameters:

Returns:



145
146
147
148
# File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 145

def click_and_hold(element)
  @actions << [:mouse, :down, [element]]
  self
end

- (ActionBuilder) context_click(element)

Performs a context-click at middle of the given element. First performs a move_to to the location of the element.

Examples:

Context-click at middle of given element

el = driver.find_element(:id, "some_id")
driver.action.context_click(el).perform

Parameters:

Returns:



282
283
284
285
# File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 282

def context_click(element)
  @actions << [:mouse, :context_click, [element]]
  self
end

- (ActionBuilder) double_click(element = nil)

Performs a double-click at middle of the given element. Equivalent to:

driver.action.move_to(element).double_click

Examples:

Double click an element

el = driver.find_element(:id, "some_id")
driver.action.double_click(el).perform

Parameters:

Returns:



205
206
207
208
# File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 205

def double_click(element = nil)
  @actions << [:mouse, :double_click, [element]]
  self
end

- (ActionBuilder) drag_and_drop(source, target)

A convenience method that performs click-and-hold at the location of the source element, moves to the location of the target element, then releases the mouse.

Examples:

Drag and drop one element onto another

el1 = driver.find_element(:id, "some_id1")
el2 = driver.find_element(:id, "some_id2")
driver.action.drag_and_drop(el1, el2).perform

Parameters:

Returns:



304
305
306
307
308
309
310
# File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 304

def drag_and_drop(source, target)
  click_and_hold source
  move_to        target
  release        target

  self
end

- (ActionBuilder) drag_and_drop_by(source, right_by, down_by)

A convenience method that performs click-and-hold at the location of the source element, moves by a given offset, then releases the mouse.

Examples:

Drag and drop an element by offset

el = driver.find_element(:id, "some_id1")
driver.action.drag_and_drop_by(el, 100, 100).perform

Parameters:

Returns:



329
330
331
332
333
334
335
# File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 329

def drag_and_drop_by(source, right_by, down_by)
  click_and_hold source
  move_by        right_by, down_by
  release

  self
end

- (ActionBuilder) key_down(*args)

Performs a modifier key press. Does not release the modifier key - subsequent interactions may assume it's kept pressed. Note that the modifier key is never released implicitly - either #key_up(key) or #send_keys(:null) must be called to release the modifier.

Equivalent to:

driver.action.click(element).send_keys(key)
# or
driver.action.click.send_keys(key)

Examples:

Press a key

driver.action.key_down(:control).perform

Press a key on an element

el = driver.find_element(:id, "some_id")
driver.action.key_down(el, :shift).perform

Parameters:

Returns:

Raises:

  • (ArgumentError)

    if the given key is not a modifier



63
64
65
66
67
68
69
70
# File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 63

def key_down(*args)
  if args.first.kind_of? Element
    @actions << [:mouse, :click, [args.shift]]
  end

  @actions << [:keyboard, :press, args]
  self
end

- (ActionBuilder) key_up(*args)

Performs a modifier key release. Releasing a non-depressed modifier key will yield undefined behaviour.

Examples:

Release a key

driver.action.key_up(:shift).perform

Release a key from an element

el = driver.find_element(:id, "some_id")
driver.action.key_up(el, :alt).perform

Parameters:

Returns:

Raises:

  • (ArgumentError)

    if the given key is not a modifier key



91
92
93
94
95
96
97
98
# File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 91

def key_up(*args)
  if args.first.kind_of? Element
    @actions << [:mouse, :click, [args.shift]]
  end

  @actions << [:keyboard, :release, args]
  self
end

- (ActionBuilder) move_by(right_by, down_by)

Moves the mouse from its current position (or 0,0) by the given offset. If the coordinates provided are outside the viewport (the mouse will end up outside the browser window) then the viewport is scrolled to match.

Examples:

Move the mouse to a certain offset from its current position

driver.action.move_by(100, 100).perform

Parameters:

  • right_by (Integer)

    horizontal offset. A negative value means moving the mouse left.

  • down_by (Integer)

    vertical offset. A negative value means moving the mouse up.

Returns:

Raises:

  • (MoveTargetOutOfBoundsError)

    if the provided offset is outside the document's boundaries.



264
265
266
267
# File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 264

def move_by(right_by, down_by)
  @actions << [:mouse, :move_by, [right_by, down_by]]
  self
end

- (ActionBuilder) move_to(element, right_by = nil, down_by = nil)

Moves the mouse to the middle of the given element. The element is scrolled into view and its location is calculated using getBoundingClientRect. Then the mouse is moved to optional offset coordinates from the element.

Note that when using offsets, both coordinates need to be passed.

Examples:

Scroll element into view and move the mouse to it

el = driver.find_element(:id, "some_id")
driver.action.move_to(el).perform
el = driver.find_element(:id, "some_id")
driver.action.move_to(el, 100, 100).perform

Parameters:

  • element (Selenium::WebDriver::Element)

    to move to.

  • right_by (Integer) (defaults to: nil)

    Optional offset from the top-left corner. A negative value means coordinates right from the element.

  • down_by (Integer) (defaults to: nil)

    Optional offset from the top-left corner. A negative value means coordinates above the element.

Returns:



235
236
237
238
239
240
241
242
243
# File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 235

def move_to(element, right_by = nil, down_by = nil)
  if right_by && down_by
    @actions << [:mouse, :move_to, [element, right_by, down_by]]
  else
    @actions << [:mouse, :move_to, [element]]
  end

  self
end

- (Object) perform

Executes the actions added to the builder.



342
343
344
345
346
347
348
# File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 342

def perform
  @actions.each { |receiver, method, args|
    @devices.fetch(receiver).__send__(method, *args)
  }

  nil
end

- (ActionBuilder) release(element = nil)

Releases the depressed left mouse button at the current mouse location.

Examples:

Releasing an element after clicking and holding it

el = driver.find_element(:id, "some_id")
driver.action.click_and_hold(el).release.perform

Returns:



161
162
163
164
# File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 161

def release(element = nil)
  @actions << [:mouse, :up, [element]]
  self
end

- (ActionBuilder) send_keys(*args)

Sends keys to the active element. This differs from calling Element#send_keys(keys) on the active element in two ways:

  • The modifier keys included in this call are not released.

  • There is no attempt to re-focus the element - so send_keys(:tab) for switching elements should work.

Examples:

Send the text "help" to an element

el = driver.find_element(:id, "some_id")
driver.action.send_keys(el, "help").perform

Send the text "help" to the currently focused element

driver.action.send_keys("help").perform

Parameters:

Returns:



121
122
123
124
125
126
127
128
# File 'rb/lib/selenium/webdriver/common/action_builder.rb', line 121

def send_keys(*args)
  if args.first.kind_of? Element
    @actions << [:mouse, :click, [args.shift]]
  end

  @actions << [:keyboard, :send_keys, args]
  self
end