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/



252
253
254
 
# File 'lib/selenium/webdriver/common/element.rb', line 252

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



75
76
77
 
# File 'lib/selenium/webdriver/common/element.rb', line 75

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

#clear ⇒ Object

Clear this element



126
127
128
 
# File 'lib/selenium/webdriver/common/element.rb', line 126

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) 


156
157
158
 
# File 'lib/selenium/webdriver/common/element.rb', line 156

def displayed?
  bridge.isElementDisplayed @id
end

#enabled? ⇒ Boolean

Is the element enabled?

Returns:

  • (Boolean) 


136
137
138
 
# File 'lib/selenium/webdriver/common/element.rb', line 136

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:



182
183
184
 
# File 'lib/selenium/webdriver/common/element.rb', line 182

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:



192
193
194
 
# File 'lib/selenium/webdriver/common/element.rb', line 192

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



231
232
233
 
# File 'lib/selenium/webdriver/common/element.rb', line 231

def ref
  @id
end

#selected? ⇒ Boolean

Is the element selected?

Returns:

  • (Boolean) 


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

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:



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/selenium/webdriver/common/element.rb', line 103

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

      arg
    else
      arg.to_s
    end
  end

  bridge.sendKeysToElement @id, values
end

#size ⇒ WebDriver::Dimension

Get the size of this element

Returns:



202
203
204
 
# File 'lib/selenium/webdriver/common/element.rb', line 202

def size
  bridge.getElementSize @id
end

#style(prop) ⇒ Object

Get the value of the given CSS property



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

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

#submit ⇒ Object

Submit this element



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

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:



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

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:



242
243
244
 
# File 'lib/selenium/webdriver/common/element.rb', line 242

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