Class: Watir::Element
Overview
Base class for HTML elements.
Constant Summary
AttributeHelper::IGNORED_ATTRIBUTES
Constants included
from Atoms
Atoms::ATOMS
Instance Method Summary
collapse
attribute_list, attributes, typed_attributes
#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, #command, #commands, #data, #datalist, #datalists, #dd, #dds, #del, #dels, #details, #detailses, #dfn, #dfns, #div, #divs, #dl, #dls, #dt, #dts, #element, #elements, #em, #embed, #embeds, #ems, #extract_selector, #fieldset, #fieldsets, #figcaption, #figcaptions, #figure, #figures, #file_field, #file_fields, #font, #fonts, #footer, #footers, #form, #forms, #frame, #frames, #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, #map, #maps, #mark, #marks, #menu, #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, #text_field, #text_fields, #textarea, #textareas, #tfoot, #tfoots, #th, #thead, #theads, #ths, #title, #titles, #tr, #track, #tracks, #trs, #u, #ul, #uls, #us, #var, #vars, #video, #videos, #wbr, #wbrs
Methods included from Atoms
load
#element_by_xpath, #elements_by_xpath, escape
Constructor Details
#initialize(parent, selector) ⇒ Element
Returns a new instance of Element.
26
27
28
29
30
31
32
33
|
# File 'lib/watir-webdriver/elements/element.rb', line 26
def initialize(parent, selector)
@parent = parent
@selector = selector
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
#method_missing(meth, *args, &blk) ⇒ Object
312
313
314
315
316
317
318
319
|
# File 'lib/watir-webdriver/elements/element.rb', line 312
def method_missing(meth, *args, &blk)
method = meth.to_s
if method =~ /^data_(.+)$/
attribute_value(method.gsub(/_/, '-'), *args)
else
super
end
end
|
Instance Method Details
#==(other) ⇒ Object
Also known as:
eql?
51
52
53
54
55
56
|
# File 'lib/watir-webdriver/elements/element.rb', line 51
def ==(other)
return false unless other.kind_of? self.class
assert_exists
@element == other.wd
end
|
#attribute_value(attribute_name) ⇒ Object
121
122
123
124
|
# File 'lib/watir-webdriver/elements/element.rb', line 121
def attribute_value(attribute_name)
assert_exists
@element.attribute attribute_name
end
|
73
74
75
76
77
78
|
# File 'lib/watir-webdriver/elements/element.rb', line 73
def click
assert_exists
assert_enabled
@element.click
run_checkers
end
|
#double_click ⇒ Object
80
81
82
83
84
85
86
87
88
89
|
# File 'lib/watir-webdriver/elements/element.rb', line 80
def double_click
assert_exists
unless driver.kind_of? WebDriver::DriverExtensions::HasInputDevices
raise NotImplementedError, "Element#double_click is not supported by this driver"
end
driver.action.double_click(@element).perform
run_checkers
end
|
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.
168
169
170
|
# File 'lib/watir-webdriver/elements/element.rb', line 168
def driver
@parent.driver
end
|
#exists? ⇒ Boolean
Also known as:
exist?
#fire_event(event_name) ⇒ Object
147
148
149
150
151
152
|
# File 'lib/watir-webdriver/elements/element.rb', line 147
def fire_event(event_name)
assert_exists
event_name = event_name.to_s.sub(/^on/, '').downcase
execute_atom :fireEvent, @element, event_name
end
|
102
103
104
105
106
107
108
109
|
# File 'lib/watir-webdriver/elements/element.rb', line 102
def flash
original_color = style("backgroundColor")
10.times do |n|
color = (n % 2 == 0) ? "red" : original_color
driver.execute_script("arguments[0].style.backgroundColor = '#{color}'", @element)
end
end
|
142
143
144
145
|
# File 'lib/watir-webdriver/elements/element.rb', line 142
def focus
assert_exists
driver.execute_script "return arguments[0].focus()", @element
end
|
59
60
61
|
# File 'lib/watir-webdriver/elements/element.rb', line 59
def hash
@element ? @element.hash : super
end
|
126
127
128
129
|
# File 'lib/watir-webdriver/elements/element.rb', line 126
def html
assert_exists
execute_atom(:getOuterHtml, @element).strip
end
|
43
44
45
46
47
48
49
|
# File 'lib/watir-webdriver/elements/element.rb', line 43
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
|
154
155
156
157
158
159
160
161
162
|
# File 'lib/watir-webdriver/elements/element.rb', line 154
def parent
assert_exists
e = execute_atom :getParentElement, @element
if e.kind_of?(WebDriver::Element)
Watir.element_class_for(e.tag_name.downcase).new(@parent, :element => e)
end
end
|
#present? ⇒ Boolean
Returns true if the element exists and is visible on the page
196
197
198
199
200
201
202
|
# File 'lib/watir-webdriver/elements/element.rb', line 196
def present?
exists? && visible?
rescue Selenium::WebDriver::Error::ObsoleteElementError, UnknownObjectException
false
end
|
#right_click ⇒ Object
91
92
93
94
95
96
97
98
99
100
|
# File 'lib/watir-webdriver/elements/element.rb', line 91
def right_click
assert_exists
unless driver.kind_of? WebDriver::DriverExtensions::HasInputDevices
raise NotImplementedError, "Element#context_click is not supported by this driver"
end
driver.action.context_click(@element).perform
run_checkers
end
|
#run_checkers ⇒ Object
213
214
215
|
# File 'lib/watir-webdriver/elements/element.rb', line 213
def run_checkers
@parent.run_checkers
end
|
#select_text(str) ⇒ Object
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
|
#send_keys(*args) ⇒ Object
131
132
133
134
|
# File 'lib/watir-webdriver/elements/element.rb', line 131
def send_keys(*args)
assert_exists
@element.send_keys(*args)
end
|
#style(property = nil) ⇒ Object
204
205
206
207
208
209
210
211
|
# File 'lib/watir-webdriver/elements/element.rb', line 204
def style(property = nil)
if property
assert_exists
@element.style property
else
attribute_value("style").to_s.strip
end
end
|
68
69
70
71
|
# File 'lib/watir-webdriver/elements/element.rb', line 68
def tag_name
assert_exists
@element.tag_name.downcase
end
|
63
64
65
66
|
# File 'lib/watir-webdriver/elements/element.rb', line 63
def text
assert_exists
@element.text
end
|
#to_subtype ⇒ Object
Cast this Element instance to a more specific subtype.
Example:
browser.element(:xpath => "//input[@type='submit']").to_subtype
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
# File 'lib/watir-webdriver/elements/element.rb', line 225
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
|
111
112
113
114
115
116
117
118
119
|
# File 'lib/watir-webdriver/elements/element.rb', line 111
def value
assert_exists
begin
@element.attribute('value') || ''
rescue WebDriver::Error::InvalidElementStateError
""
end
end
|
#visible? ⇒ Boolean
Returns true if this element is visible on the page
185
186
187
188
|
# File 'lib/watir-webdriver/elements/element.rb', line 185
def visible?
assert_exists
@element.displayed?
end
|
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.
176
177
178
179
|
# File 'lib/watir-webdriver/elements/element.rb', line 176
def wd
assert_exists
@element
end
|