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 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



12
13
14
 
# File 'lib/selenium/webdriver/common/element.rb', line 12

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

Instance Method Details

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



20
21
22
 
# File 'lib/selenium/webdriver/common/element.rb', line 20

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/



274
275
276
 
# File 'lib/selenium/webdriver/common/element.rb', line 274

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



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

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

#clear ⇒ Object

If this element is a text entry element, this will clear the value. Has no effect on other elements. Text entry elements are INPUT and TEXTAREA elements.

Note that the events fired by this event may not be as you’d expect. In particular, we don’t fire any keyboard or mouse events. If you want to ensure keyboard events are fired, consider using #send_keys with the backspace key. To ensure you get a change event, consider following with a call to #send_keys with the tab key.



140
141
142
 
# File 'lib/selenium/webdriver/common/element.rb', line 140

def clear
  bridge.clearElement @id
end

#click ⇒ Object

Click this element. If this causes a new page to load, this method will attempt to block until the page has loaded. At this point, you should discard all references to this element and any further operations performed on this element will raise a StaleElementReferenceError unless you know that the element and the page will still be present. If click() causes a new page to be loaded via an event or is done by sending a native event then the method will not wait for it to be loaded and the caller should verify that a new page has been loaded.

There are some preconditions for an element to be clicked. The element must be visible and it must have a height and width greater then 0.

Equivalent to:

driver.action.click(element)

Examples:

Click on a button


driver.find_element(:tag_name, "button").click

Raises:

  • (StaleElementReferenceError) —

    if the element no longer exists as defined



53
54
55
 
# File 'lib/selenium/webdriver/common/element.rb', line 53

def click
  bridge.clickElement @id
end

#css_value(prop) ⇒ Object Also known as: style

Get the value of the given CSS property

Note that shorthand CSS properties (e.g. background, font, border, border-top, margin, margin-top, padding, padding-top, list-style, outline, pause, cue) are not returned, in accordance with the DOM CSS2 specification - you should directly access the longhand properties (e.g. background-color) to access the desired values.

See Also:



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

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

#displayed? ⇒ Boolean

Is the element displayed?

Returns:

  • (Boolean) 


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

def displayed?
  bridge.isElementDisplayed @id
end

#enabled? ⇒ Boolean

Is the element enabled?

Returns:

  • (Boolean) 


150
151
152
 
# File 'lib/selenium/webdriver/common/element.rb', line 150

def enabled?
  bridge.isElementEnabled @id
end

#hash ⇒ Object 



25
26
27
 
# File 'lib/selenium/webdriver/common/element.rb', line 25

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

#inspect ⇒ Object 



16
17
18
 
# File 'lib/selenium/webdriver/common/element.rb', line 16

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

#location ⇒ WebDriver::Point

Get the location of this element.

Returns:



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

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:



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

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



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

def ref
  @id
end

#selected? ⇒ Boolean

Is the element selected?

Returns:

  • (Boolean) 


160
161
162
 
# File 'lib/selenium/webdriver/common/element.rb', line 160

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:



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

def send_keys(*args)
  bridge.sendKeysToElement @id, Keys.encode(args)
end

#size ⇒ WebDriver::Dimension

Get the size of this element

Returns:



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

def size
  bridge.getElementSize @id
end

#submit ⇒ Object

Submit this element



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

def submit
  bridge.submitElement @id
end

#tag_name ⇒ String

Get the tag name of the element.

Examples:

Get the tagname of an INPUT element(returns “input”)


driver.find_element(:xpath, "//input").tag_name

Returns:

  • (String) —

    The tag name of this element.



67
68
69
 
# File 'lib/selenium/webdriver/common/element.rb', line 67

def tag_name
  bridge.getElementTagName @id
end

#text ⇒ String

Get the text content of this element

Returns:



107
108
109
 
# File 'lib/selenium/webdriver/common/element.rb', line 107

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:



264
265
266
 
# File 'lib/selenium/webdriver/common/element.rb', line 264

def to_json(*args)
  WebDriver.json_dump as_json
end