Class: Watir::Element
Overview
Base class for HTML elements.
Constant Summary
AttributeHelper::IGNORED_ATTRIBUTES
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, #datalist, #datalists, #dd, #dds, #del, #dels, #details, #dfn, #dfns, #div, #divs, #dl, #dls, #dt, #dts, #elements, #em, #embed, #embeds, #ems, #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, #time, #times, #title, #titles, #tr, #track, #tracks, #trs, #ul, #uls, #var, #vars, #video, #videos, #wbr, #wbrs
#element_by_xpath, #elements_by_xpath
Constructor Details
#initialize(parent, selector) ⇒ Element
Returns a new instance of Element.
17
18
19
20
21
22
23
24
25
26
27
28
|
# File 'lib/watir-webdriver/elements/element.rb', line 17
def initialize(parent, selector)
@parent = parent
@selector = selector
unless @selector.kind_of? Hash
raise ArgumentError, "invalid argument: #{selector.inspect}"
end
if @selector.has_key?(:element)
@element = @selector[:element]
end
end
|
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(meth, *args, &blk) ⇒ Object
271
272
273
274
275
276
277
278
|
# File 'lib/watir-webdriver/elements/element.rb', line 271
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?
46
47
48
49
50
51
|
# File 'lib/watir-webdriver/elements/element.rb', line 46
def ==(other)
return false unless other.kind_of? self.class
assert_exists
@element == other.element
end
|
#attribute_value(attribute_name) ⇒ Object
110
111
112
113
|
# File 'lib/watir-webdriver/elements/element.rb', line 110
def attribute_value(attribute_name)
assert_exists
@element.attribute attribute_name
end
|
68
69
70
71
72
73
|
# File 'lib/watir-webdriver/elements/element.rb', line 68
def click
assert_exists
assert_enabled
@element.click
run_checkers
end
|
#double_click ⇒ Object
75
76
77
78
79
80
81
|
# File 'lib/watir-webdriver/elements/element.rb', line 75
def double_click
assert_exists
raise NotImplementedError, "need support in WebDriver"
@element.double_click
run_checkers
end
|
152
153
154
|
# File 'lib/watir-webdriver/elements/element.rb', line 152
def driver
@parent.driver
end
|
#element ⇒ Object
Also known as:
wd
156
157
158
159
|
# File 'lib/watir-webdriver/elements/element.rb', line 156
def element
assert_exists
@element
end
|
#exists? ⇒ Boolean
Also known as:
exist?
30
31
32
33
34
35
|
# File 'lib/watir-webdriver/elements/element.rb', line 30
def exists?
assert_exists
true
rescue UnknownObjectException, UnknownFrameException
false
end
|
#fire_event(event_name, bubble = false) ⇒ Object
136
137
138
139
140
|
# File 'lib/watir-webdriver/elements/element.rb', line 136
def fire_event(event_name, bubble = false)
assert_exists
event_name = event_name.to_s.sub(/^on/, '')
browserbot('triggerEvent', @element, event_name, bubble)
end
|
91
92
93
94
95
96
97
98
|
# File 'lib/watir-webdriver/elements/element.rb', line 91
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
|
131
132
133
134
|
# File 'lib/watir-webdriver/elements/element.rb', line 131
def focus
assert_exists
driver.execute_script "return arguments[0].focus()", @element
end
|
54
55
56
|
# File 'lib/watir-webdriver/elements/element.rb', line 54
def hash
@element ? @element.hash : super
end
|
115
116
117
118
|
# File 'lib/watir-webdriver/elements/element.rb', line 115
def html
assert_exists
browserbot('getOuterHTML', @element).strip
end
|
38
39
40
41
42
43
44
|
# File 'lib/watir-webdriver/elements/element.rb', line 38
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
|
142
143
144
145
146
147
148
149
150
|
# File 'lib/watir-webdriver/elements/element.rb', line 142
def parent
assert_exists
e = driver.execute_script "return arguments[0].parentNode", @element
if e.kind_of?(WebDriver::Element)
Watir.element_class_for(e.tag_name).new(@parent, :element => e)
end
end
|
#present? ⇒ Boolean
Returns true if the element exists and is visible on the page
177
178
179
|
# File 'lib/watir-webdriver/elements/element.rb', line 177
def present?
exists? && visible?
end
|
#right_click ⇒ Object
83
84
85
86
87
88
89
|
# File 'lib/watir-webdriver/elements/element.rb', line 83
def right_click
assert_exists
raise NotImplementedError, "need support in WebDriver"
@element.right_click
run_checkers
end
|
#run_checkers ⇒ Object
190
191
192
|
# File 'lib/watir-webdriver/elements/element.rb', line 190
def run_checkers
@parent.run_checkers
end
|
#send_keys(*args) ⇒ Object
120
121
122
123
|
# File 'lib/watir-webdriver/elements/element.rb', line 120
def send_keys(*args)
assert_exists
@element.send_keys(*args)
end
|
#style(property = nil) ⇒ Object
181
182
183
184
185
186
187
188
|
# File 'lib/watir-webdriver/elements/element.rb', line 181
def style(property = nil)
if property
assert_exists
@element.style property
else
attribute_value("style") || ''
end
end
|
63
64
65
66
|
# File 'lib/watir-webdriver/elements/element.rb', line 63
def tag_name
assert_exists
@element.tag_name
end
|
58
59
60
61
|
# File 'lib/watir-webdriver/elements/element.rb', line 58
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
# File 'lib/watir-webdriver/elements/element.rb', line 202
def to_subtype
elem = element()
tag_name = elem.tag_name
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
|
100
101
102
103
104
105
106
107
108
|
# File 'lib/watir-webdriver/elements/element.rb', line 100
def value
assert_exists
begin
@element.value || ''
rescue WebDriver::Error::ElementNotEnabledError
""
end
end
|
#visible? ⇒ Boolean
Returns true if this element is visible on the page
166
167
168
169
|
# File 'lib/watir-webdriver/elements/element.rb', line 166
def visible?
assert_exists
@element.displayed?
end
|