Class: Selenium::WebDriver::Element

Inherits:
Object
  • Object
show all
Includes:
SearchContext
Defined in:
lib/selenium/webdriver/common/element.rb

Constant Summary

Constants included from SearchContext

SearchContext::FINDERS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from SearchContext

#find_element, #find_elements

Constructor Details

#initialize(bridge, id) ⇒ Element

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.

Creates a new Element



14
15
16
 
# File 'lib/selenium/webdriver/common/element.rb', line 14

def initialize(bridge, id)
  @bridge, @id = bridge, id
end

Instance Attribute Details

#bridge ⇒ Object (readonly)

Returns the value of attribute bridge.



6
7
8
 
# File 'lib/selenium/webdriver/common/element.rb', line 6

def bridge
  @bridge
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql? 



22
23
24
 
# File 'lib/selenium/webdriver/common/element.rb', line 22

def ==(other)
  other.kind_of?(self.class) && bridge.elementEquals(self, other)
end

#as_json(opts = nil) ⇒ Object

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.

For Rails 3 - jonathanjulian.com/2010/04/rails-to_json-or-as_json/



304
305
306
 
# File 'lib/selenium/webdriver/common/element.rb', line 304

def as_json(opts = nil)
  { :ELEMENT => @id }
end

#attribute(name) ⇒ String? Also known as: []

Get the value of a the given attribute of the element. Will return the current value, even if this has been modified after the page has been loaded. More exactly, this method will return the value of the given attribute, unless that attribute is not present, in which case the value of the property with the same name is returned. If neither value is set, nil is returned. The “style” attribute is converted as best can be to a text representation with a trailing semi-colon. The following are deemed to be “boolean” attributes, and will return either “true” or “false”:

async, autofocus, autoplay, checked, compact, complete, controls, declare, defaultchecked, defaultselected, defer, disabled, draggable, ended, formnovalidate, hidden, indeterminate, iscontenteditable, ismap, itemscope, loop, multiple, muted, nohref, noresize, noshade, novalidate, nowrap, open, paused, pubdate, readonly, required, reversed, scoped, seamless, seeking, selected, spellcheck, truespeed, willvalidate

Finally, the following commonly mis-capitalized attribute/property names are evaluated as expected:

class, readonly

Parameters:

Returns:

  • (String, nil) —

    attribute value



86
87
88
 
# File 'lib/selenium/webdriver/common/element.rb', line 86

def attribute(name)
  bridge.getElementAttribute @id, name
end

#clear ⇒ Object

Clear this element



133
134
135
 
# File 'lib/selenium/webdriver/common/element.rb', line 133

def clear
  bridge.clearElement @id
end

#click ⇒ Object

Click the element



35
36
37
 
# File 'lib/selenium/webdriver/common/element.rb', line 35

def click
  bridge.clickElement @id
end

#displayed? ⇒ Boolean

Is the element displayed?

Returns:

  • (Boolean) 


163
164
165
 
# File 'lib/selenium/webdriver/common/element.rb', line 163

def displayed?
  bridge.isElementDisplayed @id
end

#drag_and_drop_by(right_by, down_by) ⇒ Object

Drag and drop this element

Parameters:

  • right_by (Integer) —

    number of pixels to drag right

  • down_by (Integer) —

    number of pixels to drag down



238
239
240
 
# File 'lib/selenium/webdriver/common/element.rb', line 238

def drag_and_drop_by(right_by, down_by)
  bridge.dragElement @id, right_by, down_by
end

#drag_and_drop_on(other) ⇒ Object

Drag and drop this element on the given element

Parameters:



248
249
250
251
252
253
254
255
256
 
# File 'lib/selenium/webdriver/common/element.rb', line 248

def drag_and_drop_on(other)
  current_location = location()
  destination      = other.location

  right = destination.x - current_location.x
  down  = destination.y - current_location.y

  drag_and_drop_by right, down
end

#enabled? ⇒ Boolean

Is the element enabled?

Returns:

  • (Boolean) 


143
144
145
 
# File 'lib/selenium/webdriver/common/element.rb', line 143

def enabled?
  bridge.isElementEnabled @id
end

#hash ⇒ Object 



27
28
29
 
# File 'lib/selenium/webdriver/common/element.rb', line 27

def hash
  @id.hash ^ @bridge.hash
end

#inspect ⇒ Object 



18
19
20
 
# File 'lib/selenium/webdriver/common/element.rb', line 18

def inspect
  '#<%s:0x%x id=%s tag_name=%s>' % [self.class, hash*2, @id.inspect, tag_name.inspect]
end

#location ⇒ WebDriver::Point

Get the location of this element.

Returns:



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

def location
  bridge.getElementLocation @id
end

#location_once_scrolled_into_view ⇒ WebDriver::Point

Determine an element’s location on the screen once it has been scrolled into view.

Returns:



215
216
217
 
# File 'lib/selenium/webdriver/common/element.rb', line 215

def location_once_scrolled_into_view
  bridge.getElementLocationOnceScrolledIntoView @id
end

#ref ⇒ Object

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.

for SearchContext and execute_script



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

def ref
  @id
end

#select ⇒ Object

Select this element



171
172
173
 
# File 'lib/selenium/webdriver/common/element.rb', line 171

def select
  bridge.setElementSelected @id
end

#selected? ⇒ Boolean

Is the element selected?

Returns:

  • (Boolean) 


153
154
155
 
# File 'lib/selenium/webdriver/common/element.rb', line 153

def selected?
  bridge.isElementSelected @id
end

#send_keys(*args) ⇒ Object Also known as: send_key

Send keystrokes to this element

Examples:

element.send_keys "foo"                     #=> value: 'foo'
element.send_keys "tet", :arrow_left, "s"   #=> value: 'test'
element.send_keys [:control, 'a'], :space   #=> value: ' '

Parameters:

See Also:



114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/selenium/webdriver/common/element.rb', line 114

def send_keys(*args)
  args.each do |arg|
    case arg
    when Symbol
      arg = Keys[arg]
    when Array
      arg = arg.map { |e| e.kind_of?(Symbol) ? Keys[e] : e }.join
      arg << Keys[:null]
    end

    bridge.sendKeysToElement(@id, arg.to_s)
  end
end

#size ⇒ WebDriver::Dimension

Get the size of this element

Returns:



225
226
227
 
# File 'lib/selenium/webdriver/common/element.rb', line 225

def size
  bridge.getElementSize @id
end

#style(prop) ⇒ Object

Get the value of the given CSS property



195
196
197
 
# File 'lib/selenium/webdriver/common/element.rb', line 195

def style(prop)
  bridge.getElementValueOfCssProperty @id, prop
end

#submit ⇒ Object

Submit this element



179
180
181
 
# File 'lib/selenium/webdriver/common/element.rb', line 179

def submit
  bridge.submitElement @id
end

#tag_name ⇒ String

Get the tag name of this element

Returns:



45
46
47
 
# File 'lib/selenium/webdriver/common/element.rb', line 45

def tag_name
  bridge.getElementTagName @id
end

#text ⇒ String

Get the text content of this element

Returns:



96
97
98
 
# File 'lib/selenium/webdriver/common/element.rb', line 96

def text
  bridge.getElementText @id
end

#to_json(*args) ⇒ Object

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.

Convert to a WebElement JSON Object for transmission over the wire.

See Also:



294
295
296
 
# File 'lib/selenium/webdriver/common/element.rb', line 294

def to_json(*args)
  as_json.to_json(*args)
end

#toggle ⇒ Object

Toggle this element



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

def toggle
  bridge.toggleElement @id
end

#value ⇒ String

Get the value of this element

Returns:



55
56
57
58
 
# File 'lib/selenium/webdriver/common/element.rb', line 55

def value
  warn "#{self.class}#value is deprecated, please use #{self.class}#attribute('value')"
  bridge.getElementValue @id
end