Class: Watir::Element

Inherits:
Object
  • Object
show all
Extended by:
AttributeHelper
Includes:
Container, EventuallyPresent, Exception
Defined in:
lib/watir-webdriver/elements/element.rb,
lib/watir-webdriver/extensions/select_text.rb

Overview

Base class for HTML elements.

Direct Known Subclasses

HTMLElement

Constant Summary

Constant Summary

Constants included from Atoms

Atoms::ATOMS

Instance Method Summary (collapse)

Methods included from AttributeHelper

attribute, attribute_list, inherit_attributes_from, method, typed_attributes

Methods included from EventuallyPresent

#wait_until_present, #wait_while_present, #when_present

Methods included from Container

#a, #abbr, #abbrs, #address, #addresses, #area, #areas, #article, #articles, #as, #aside, #asides, #audio, #audios, #b, #base, #bases, #bdi, #bdis, #bdo, #bdos, #blockquote, #blockquotes, #body, #bodys, #br, #brs, #bs, #button, #buttons, #canvas, #canvases, #caption, #captions, #checkbox, #checkboxes, #cite, #cites, #code, #codes, #col, #colgroup, #colgroups, #cols, #data, #datalist, #datalists, #datas, #dd, #dds, #del, #dels, #details, #detailses, #dfn, #dfns, #dialog, #dialogs, #div, #divs, #dl, #dls, #dt, #dts, #element, #elements, #em, #embed, #embeds, #ems, #extract_selector, #field_set, #field_sets, #fieldset, #fieldsets, #figcaption, #figcaptions, #figure, #figures, #file_field, #file_fields, #font, #fonts, #footer, #footers, #form, #forms, #frame, #frames, #frameset, #framesets, #h1, #h1s, #h2, #h2s, #h3, #h3s, #h4, #h4s, #h5, #h5s, #h6, #h6s, #head, #header, #headers, #heads, #hgroup, #hgroups, #hidden, #hiddens, #hr, #hrs, #htmls, #i, #iframe, #iframes, #image, #images, #img, #imgs, #input, #inputs, #ins, #inses, #is, #kbd, #kbds, #keygen, #keygens, #label, #labels, #legend, #legends, #li, #link, #links, #lis, #main, #mains, #map, #maps, #mark, #marks, #menu, #menuitem, #menuitems, #menus, #meta, #metas, #meter, #meters, #nav, #navs, #noscript, #noscripts, #object, #objects, #ol, #ols, #optgroup, #optgroups, #option, #options, #output, #outputs, #p, #param, #params, #pre, #pres, #progress, #progresses, #ps, #q, #qs, #radio, #radios, #rp, #rps, #rt, #rts, #rubies, #ruby, #s, #samp, #samps, #script, #scripts, #section, #sections, #select, #select_list, #select_lists, #selects, #small, #smalls, #source, #sources, #span, #spans, #ss, #strong, #strongs, #styles, #sub, #subs, #summaries, #summary, #sup, #sups, #table, #tables, #tbody, #tbodys, #td, #tds, #template, #templates, #text_field, #text_fields, #textarea, #textareas, #tfoot, #tfoots, #th, #thead, #theads, #ths, #time, #times, #title, #titles, #tr, #track, #tracks, #trs, #u, #ul, #uls, #us, #var, #vars, #video, #videos, #wbr, #wbrs

Methods included from Atoms

load

Methods included from XpathSupport

downcase, escape

Constructor Details

- (Element) initialize(parent, selector)

Returns a new instance of Element



27
28
29
30
31
32
33
34
35
# File 'lib/watir-webdriver/elements/element.rb', line 27

def initialize(parent, selector)
  @parent   = parent
  @selector = selector
  @element  = nil

  unless @selector.kind_of? Hash
    raise ArgumentError, "invalid argument: #{selector.inspect}"
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

- (Object) method_missing(meth, *args, &blk) (private)



575
576
577
578
579
580
581
582
# File 'lib/watir-webdriver/elements/element.rb', line 575

def method_missing(meth, *args, &blk)
  method = meth.to_s
  if method =~ ElementLocator::WILDCARD_ATTRIBUTE
    attribute_value(method.gsub(/_/, '-'), *args)
  else
    super
  end
end

Instance Method Details

- (Object) ==(other) Also known as: eql?

Returns true if two elements are equal.

Examples:

browser.a(:id => "foo") == browser.a(:id => "foo")
#=> true


67
68
69
70
71
72
# File 'lib/watir-webdriver/elements/element.rb', line 67

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

  assert_exists
  @element == other.wd
end

- (String) attribute_value(attribute_name)

Returns given attribute value of element.

Examples:

browser.a(:id => "foo").attribute_value "href"
#=> "http://watir.com"

Parameters:

  • attribute_name (String)

Returns:

  • (String)


273
274
275
276
# File 'lib/watir-webdriver/elements/element.rb', line 273

def attribute_value(attribute_name)
  assert_exists
  @element.attribute attribute_name
end

- (Watir::Browser) browser

Returns browser.

Returns:



493
494
495
# File 'lib/watir-webdriver/elements/element.rb', line 493

def browser
  @parent.browser
end

- (String) class_name

Returns value of className property

Returns:

  • (String)

    value of className property



25
# File 'lib/watir-webdriver/elements/element.rb', line 25

attribute String, :class_name, :className

- (Object) click(*modifiers)

Clicks the element, optionally while pressing the given modifier keys. Note that support for holding a modifier key is currently experimental, and may not work at all.

Examples:

Click an element

element.click

Click an element with shift key pressed

element.click(:shift)

Click an element with several modifier keys pressed

element.click(:shift, :control)

Parameters:

  • Modifier (:shift, :alt, :control, :command, :meta)

    key(s) to press while clicking.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/watir-webdriver/elements/element.rb', line 118

def click(*modifiers)
  assert_exists
  assert_enabled

  if modifiers.any?
    assert_has_input_devices_for "click(#{modifiers.join ', '})"

    action = driver.action
    modifiers.each { |mod| action.key_down mod }
    action.click @element
    modifiers.each { |mod| action.key_up mod }

    action.perform
  else
    @element.click
  end

  run_checkers
end

- (Object) double_click

Double clicks the element. Note that browser support may vary.

Examples:

browser.a(:id => "foo").double_click


146
147
148
149
150
151
152
# File 'lib/watir-webdriver/elements/element.rb', line 146

def double_click
  assert_exists
  assert_has_input_devices_for :double_click

  driver.action.double_click(@element).perform
  run_checkers
end

- (Object) drag_and_drop_by(right_by, down_by)

Drag and drop this element by the given offsets. Note that browser support may vary.

Examples:

browser.div(:id => "draggable").drag_and_drop_by 100, -200

Parameters:

  • right_by (Fixnum)
  • down_by (Fixnum)


216
217
218
219
220
221
222
223
# File 'lib/watir-webdriver/elements/element.rb', line 216

def drag_and_drop_by(right_by, down_by)
  assert_exists
  assert_has_input_devices_for :drag_and_drop_by

  driver.action.
         drag_and_drop_by(@element, right_by, down_by).
         perform
end

- (Object) drag_and_drop_on(other)

Drag and drop this element on to another element instance. Note that browser support may vary.

Examples:

a = browser.div(:id => "draggable")
b = browser.div(:id => "droppable")
a.drag_and_drop_on b


195
196
197
198
199
200
201
202
203
# File 'lib/watir-webdriver/elements/element.rb', line 195

def drag_and_drop_on(other)
  assert_is_element other
  assert_exists
  assert_has_input_devices_for :drag_and_drop_on

  driver.action.
         drag_and_drop(@element, other.wd).
         perform
end

- (Object) driver

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.



384
385
386
# File 'lib/watir-webdriver/elements/element.rb', line 384

def driver
  @parent.driver
end

- (Boolean) exists? Also known as: exist?

Returns true if element exists.

Returns:

  • (Boolean)


43
44
45
46
47
48
# File 'lib/watir-webdriver/elements/element.rb', line 43

def exists?
  assert_exists
  true
rescue UnknownObjectException, UnknownFrameException
  false
end

- (Object) fire_event(event_name)

Simulates JavaScript events on element. Note that you may omit “on” from event name.

Examples:

browser.a(:id => "foo").fire_event :click
browser.a(:id => "foo").fire_event "mousemove"
browser.a(:id => "foo").fire_event "onmouseover"

Parameters:

  • event_name (String, Symbol)


359
360
361
362
363
364
# File 'lib/watir-webdriver/elements/element.rb', line 359

def fire_event(event_name)
  assert_exists
  event_name = event_name.to_s.sub(/^on/, '').downcase

  execute_atom :fireEvent, @element, event_name
end

- (Object) flash

Flashes (change background color far a moment) element.

Examples:

browser.div(:id => "draggable").flash


232
233
234
235
236
237
238
239
240
241
242
243
244
# File 'lib/watir-webdriver/elements/element.rb', line 232

def flash
  background_color = style("backgroundColor")
  element_color = driver.execute_script("arguments[0].style.backgroundColor", @element)

  10.times do |n|
    color = (n % 2 == 0) ? "red" : background_color
    driver.execute_script("arguments[0].style.backgroundColor = '#{color}'", @element)
  end

  driver.execute_script("arguments[0].style.backgroundColor = arguments[1]", @element, element_color)

  self
end

- (Object) focus

Focuses element. Note that Firefox queues focus events until the window actually has focus.



331
332
333
334
# File 'lib/watir-webdriver/elements/element.rb', line 331

def focus
  assert_exists
  driver.execute_script "return arguments[0].focus()", @element
end

- (Boolean) focused?

Returns true if this element is focused.

Returns:

  • (Boolean)


342
343
344
345
# File 'lib/watir-webdriver/elements/element.rb', line 342

def focused?
  assert_exists
  @element == driver.switch_to.active_element
end

- (Object) hash



75
76
77
# File 'lib/watir-webdriver/elements/element.rb', line 75

def hash
  @element ? @element.hash : super
end

- (Object) hover

Moves the mouse to the middle of this element. Note that browser support may vary.

Examples:

browser.a(:id => "foo").hover


178
179
180
181
182
183
# File 'lib/watir-webdriver/elements/element.rb', line 178

def hover
  assert_exists
  assert_has_input_devices_for :hover

  driver.action.move_to(@element).perform
end

- (String) id

temporarily add :id and :class_name manually since they're no longer specified in the HTML spec.

TODO: use IDL from DOM core - dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html

Returns:

  • (String)

    value of id property

See Also:



24
# File 'lib/watir-webdriver/elements/element.rb', line 24

attribute String, :id, :id

- (String) inner_html

Returns inner HTML code of element.

Examples:

browser.div(:id => "foo").html
#=> "<a>Click</a>"

Returns:

  • (String)


305
306
307
308
# File 'lib/watir-webdriver/elements/element.rb', line 305

def inner_html
  assert_exists
  execute_atom(:getInnerHtml, @element).strip
end

- (Object) inspect



51
52
53
54
55
56
57
# File 'lib/watir-webdriver/elements/element.rb', line 51

def inspect
  if @selector.has_key?(:element)
    '#<%s:0x%x located=%s selector=%s>' % [self.class, hash*2, !!@element, '{:element=>(webdriver element)}']
  else
    '#<%s:0x%x located=%s selector=%s>' % [self.class, hash*2, !!@element, selector_string]
  end
end

- (String) outer_html Also known as: html

Returns outer (inner + element itself) HTML code of element.

Examples:

browser.div(:id => "foo").html
#=> "<div id=\"foo\"><a>Click</a></div>"

Returns:

  • (String)


288
289
290
291
# File 'lib/watir-webdriver/elements/element.rb', line 288

def outer_html
  assert_exists
  execute_atom(:getOuterHtml, @element).strip
end

- (Object) parent

Returns parent element of current element.



370
371
372
373
374
375
376
377
378
# File 'lib/watir-webdriver/elements/element.rb', line 370

def parent
  assert_exists

  e = execute_atom :getParentElement, @element

  if e.kind_of?(Selenium::WebDriver::Element)
    Watir.element_class_for(e.tag_name.downcase).new(@parent, :element => e)
  end
end

- (Boolean) present?

Returns true if the element exists and is visible on the page.

Returns:

  • (Boolean)

See Also:



415
416
417
418
419
420
421
# File 'lib/watir-webdriver/elements/element.rb', line 415

def present?
  exists? && visible?
rescue Selenium::WebDriver::Error::ObsoleteElementError, UnknownObjectException
  # if the element disappears between the exists? and visible? calls,
  # consider it not present.
  false
end

- (Object) right_click

Right clicks the element. Note that browser support may vary.

Examples:

browser.a(:id => "foo").right_click


162
163
164
165
166
167
168
# File 'lib/watir-webdriver/elements/element.rb', line 162

def right_click
  assert_exists
  assert_has_input_devices_for :right_click

  driver.action.context_click(@element).perform
  run_checkers
end

- (Object) run_checkers

Runs checkers.



449
450
451
# File 'lib/watir-webdriver/elements/element.rb', line 449

def run_checkers
  @parent.run_checkers
end

- (Object) select_text(str)



5
6
7
8
# File 'lib/watir-webdriver/extensions/select_text.rb', line 5

def select_text(str)
  assert_exists
  execute_atom :selectText, @element, str
end

- (Object) send_keys(*args)

Sends sequence of keystrokes to element.

Examples:

browser.div(:id => "foo").send_keys "Watir", :return

Parameters:

  • *args (String, Symbol)


319
320
321
322
# File 'lib/watir-webdriver/elements/element.rb', line 319

def send_keys(*args)
  assert_exists
  @element.send_keys(*args)
end

- (String) style(property = nil)

Returns given style property of this element.

Examples:

browser.a(:id => "foo").style
#=> "display: block"
browser.a(:id => "foo").style "display"
#=> "block"

Parameters:

  • property (String) (defaults to: nil)

Returns:

  • (String)


436
437
438
439
440
441
442
443
# File 'lib/watir-webdriver/elements/element.rb', line 436

def style(property = nil)
  if property
    assert_exists
    @element.style property
  else
    attribute_value("style").to_s.strip
  end
end

- (String) tag_name

Returns tag name of the element.

Returns:

  • (String)


96
97
98
99
# File 'lib/watir-webdriver/elements/element.rb', line 96

def tag_name
  assert_exists
  @element.tag_name.downcase
end

- (String) text

Returns the text of the element.

Returns:

  • (String)


85
86
87
88
# File 'lib/watir-webdriver/elements/element.rb', line 85

def text
  assert_exists
  @element.text
end

- (Object) to_subtype

Cast this Element instance to a more specific subtype.

Examples:

browser.element(:xpath => "//input[@type='submit']").to_subtype
#=> #<Watir::Button>


461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
# File 'lib/watir-webdriver/elements/element.rb', line 461

def to_subtype
  elem = wd()
  tag_name = elem.tag_name.downcase

  klass = nil

  if tag_name == "input"
    klass = case elem.attribute(:type)
      when *Button::VALID_TYPES
        Button
      when 'checkbox'
        CheckBox
      when 'radio'
        Radio
      when 'file'
        FileField
      else
        TextField
      end
  else
    klass = Watir.element_class_for(tag_name)
  end

  klass.new(@parent, :element => elem)
end

- (String) value

Returns value of the element.

Returns:

  • (String)


252
253
254
255
256
257
258
259
260
# File 'lib/watir-webdriver/elements/element.rb', line 252

def value
  assert_exists

  begin
    @element.attribute('value') || ''
  rescue Selenium::WebDriver::Error::InvalidElementStateError
    ""
  end
end

- (Boolean) visible?

Returns true if this element is visible on the page.

Returns:

  • (Boolean)


403
404
405
406
# File 'lib/watir-webdriver/elements/element.rb', line 403

def visible?
  assert_exists
  @element.displayed?
end

- (Object) wd

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.



392
393
394
395
# File 'lib/watir-webdriver/elements/element.rb', line 392

def wd
  assert_exists
  @element
end