Class: Selenium::SeleniumDriver

Inherits:
Object
  • Object
show all
Includes:
Selenium
Defined in:
lib/selenium/openqa/selenium.rb

Constant Summary

Constants included from Selenium

SeleneseInterpreter

Instance Method Summary collapse

Constructor Details

#initialize(server_host, server_port, browserStartCommand, browserURL, timeout = 30000) ⇒ SeleniumDriver

Returns a new instance of SeleniumDriver.



125
126
127
128
129
130
131
 
# File 'lib/selenium/openqa/selenium.rb', line 125

def initialize(server_host, server_port, browserStartCommand, browserURL, timeout=30000)
    @server_host = server_host
    @server_port = server_port
    @browserStartCommand = browserStartCommand
    @browserURL = browserURL
    @timeout = timeout
end

Instance Method Details

#add_location_strategy(strategyName, functionDefinition) ⇒ Object

Defines a new function for Selenium to locate elements on the page. For example, if you define the strategy “foo”, and someone runs click(“foo=blah”), we’ll run your function, passing you the string “blah”, and click on the element that your function returns, or throw an “Element not found” error if your function returns null.

We’ll pass three arguments to your function:

  • locator: the string the user passed in

  • inWindow: the currently selected window

  • inDocument: the currently selected document

The function must return null if the element can’t be found.

‘strategyName’ is the name of the strategy to define; this should use only letters [a-zA-Z] with no spaces or other punctuation. ‘functionDefinition’ is a string defining the body of a function in JavaScript. For example: return inDocument.getElementById(locator);



1454
1455
1456
 
# File 'lib/selenium/openqa/selenium.rb', line 1454

def add_location_strategy(strategyName,functionDefinition)
    do_command("addLocationStrategy", [strategyName,functionDefinition,])
end

#add_selection(locator, optionLocator) ⇒ Object

Add a selection to the set of selected options in a multi-select element using an option locator.

‘locator’ is an element locator identifying a multi-select box ‘optionLocator’ is an option locator (a label by default)

See Also:

  • for details of option locators


560
561
562
 
# File 'lib/selenium/openqa/selenium.rb', line 560

def add_selection(locator,optionLocator)
    do_command("addSelection", [locator,optionLocator,])
end

#allow_native_xpath(allow) ⇒ Object

Specifies whether Selenium should use the native in-browser implementation of XPath (if any native version is available); if you pass “false” to this function, we will always use our pure-JavaScript xpath library. Using the pure-JS xpath library can improve the consistency of xpath element locators between different browser vendors, but the pure-JS version is much slower than the native implementations.

‘allow’ is boolean, true means we’ll prefer to use native XPath; false means we’ll only use JS XPath



1321
1322
1323
 
# File 'lib/selenium/openqa/selenium.rb', line 1321

def allow_native_xpath(allow)
    do_command("allowNativeXpath", [allow,])
end

#alt_key_down ⇒ Object

Press the alt key and hold it down until doAltUp() is called or a new page is loaded.



327
328
329
 
# File 'lib/selenium/openqa/selenium.rb', line 327

def alt_key_down()
    do_command("altKeyDown", [])
end

#alt_key_up ⇒ Object

Release the alt key.



334
335
336
 
# File 'lib/selenium/openqa/selenium.rb', line 334

def alt_key_up()
    do_command("altKeyUp", [])
end

#answer_on_next_prompt(answer) ⇒ Object

Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()].

‘answer’ is the answer to give in response to the prompt pop-up



745
746
747
 
# File 'lib/selenium/openqa/selenium.rb', line 745

def answer_on_next_prompt(answer)
    do_command("answerOnNextPrompt", [answer,])
end

#assign_id(locator, identifier) ⇒ Object

Temporarily sets the “id” attribute of the specified element, so you can locate it in the future using its ID rather than a slow/complicated XPath. This ID will disappear once the page is reloaded.

‘locator’ is an element locator pointing to an element ‘identifier’ is a string to be used as the ID of the specified element



1308
1309
1310
 
# File 'lib/selenium/openqa/selenium.rb', line 1308

def assign_id(locator,identifier)
    do_command("assignId", [locator,identifier,])
end

#capture_screenshot(filename) ⇒ Object

Captures a PNG screenshot to the specified file.

‘filename’ is the absolute path to the file to be written, e.g. “c:blahscreenshot.png”



1471
1472
1473
 
# File 'lib/selenium/openqa/selenium.rb', line 1471

def capture_screenshot(filename)
    do_command("captureScreenshot", [filename,])
end

#check(locator) ⇒ Object

Check a toggle-button (checkbox/radio)

‘locator’ is an element locator



498
499
500
 
# File 'lib/selenium/openqa/selenium.rb', line 498

def check(locator)
    do_command("check", [locator,])
end

#choose_cancel_on_next_confirmation ⇒ Object

By default, Selenium’s overridden window.confirm() function will return true, as if the user had manually clicked OK; after running this command, the next call to confirm() will return false, as if the user had clicked Cancel. Selenium will then resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call this command for each confirmation.



722
723
724
 
# File 'lib/selenium/openqa/selenium.rb', line 722

def choose_cancel_on_next_confirmation()
    do_command("chooseCancelOnNextConfirmation", [])
end

#choose_ok_on_next_confirmation ⇒ Object

Undo the effect of calling chooseCancelOnNextConfirmation. Note that Selenium’s overridden window.confirm() function will normally automatically return true, as if the user had manually clicked OK, so you shouldn’t need to use this command unless for some reason you need to change your mind prior to the next confirmation. After any confirmation, Selenium will resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call chooseCancelOnNextConfirmation for each confirmation.



736
737
738
 
# File 'lib/selenium/openqa/selenium.rb', line 736

def choose_ok_on_next_confirmation()
    do_command("chooseOkOnNextConfirmation", [])
end

#click(locator) ⇒ Object

Clicks on a link, button, checkbox or radio button. If the click action causes a new page to load (like a link usually does), call waitForPageToLoad.

‘locator’ is an element locator



241
242
243
 
# File 'lib/selenium/openqa/selenium.rb', line 241

def click(locator)
    do_command("click", [locator,])
end

#click_at(locator, coordString) ⇒ Object

Clicks on a link, button, checkbox or radio button. If the click action causes a new page to load (like a link usually does), call waitForPageToLoad.

‘locator’ is an element locator ‘coordString’ is specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.



262
263
264
 
# File 'lib/selenium/openqa/selenium.rb', line 262

def click_at(locator,coordString)
    do_command("clickAt", [locator,coordString,])
end

#close ⇒ Object

Simulates the user clicking the “close” button in the titlebar of a popup window or tab.



767
768
769
 
# File 'lib/selenium/openqa/selenium.rb', line 767

def close()
    do_command("close", [])
end

#control_key_down ⇒ Object

Press the control key and hold it down until doControlUp() is called or a new page is loaded.



341
342
343
 
# File 'lib/selenium/openqa/selenium.rb', line 341

def control_key_down()
    do_command("controlKeyDown", [])
end

#control_key_up ⇒ Object

Release the control key.



348
349
350
 
# File 'lib/selenium/openqa/selenium.rb', line 348

def control_key_up()
    do_command("controlKeyUp", [])
end

#create_cookie(nameValuePair, optionsString) ⇒ Object

Create a new cookie whose path and domain are same with those of current page under test, unless you specified a path for this cookie explicitly.

‘nameValuePair’ is name and value of the cookie in a format “name=value” ‘optionsString’ is options for the cookie. Currently supported options include ‘path’ and ‘max_age’. the optionsString’s format is “path=/path/, max_age=60”. The order of options are irrelevant, the unit of the value of ‘max_age’ is second.



1398
1399
1400
 
# File 'lib/selenium/openqa/selenium.rb', line 1398

def create_cookie(nameValuePair,optionsString)
    do_command("createCookie", [nameValuePair,optionsString,])
end

#delete_cookie(name, path) ⇒ Object

Delete a named cookie with specified path.

‘name’ is the name of the cookie to be deleted ‘path’ is the path property of the cookie to be deleted



1407
1408
1409
 
# File 'lib/selenium/openqa/selenium.rb', line 1407

def delete_cookie(name,path)
    do_command("deleteCookie", [name,path,])
end

#do_command(verb, args) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/selenium/openqa/selenium.rb', line 147

def do_command(verb, args)
    timeout(@timeout) do
        http = Net::HTTP.new(@server_host, @server_port)
        command_string = '/selenium-server/driver/?cmd=' + CGI::escape(verb)
        args.length.times do |i|
            arg_num = (i+1).to_s
            command_string = command_string + "&" + arg_num + "=" + CGI::escape(args[i].to_s)
        end
        if @session_id != nil
            command_string = command_string + "&sessionId=" + @session_id.to_s
        end
        #print "Requesting --->" + command_string + "\n"
        response = http.get(command_string)
        #print "RESULT: " + response.body + "\n\n"
        if (response.body[0..1] != "OK")
            raise SeleniumCommandError, response.body
        end
        return response.body
    end
end

#double_click(locator) ⇒ Object

Double clicks on a link, button, checkbox or radio button. If the double click action causes a new page to load (like a link usually does), call waitForPageToLoad.

‘locator’ is an element locator



251
252
253
 
# File 'lib/selenium/openqa/selenium.rb', line 251

def double_click(locator)
    do_command("doubleClick", [locator,])
end

#double_click_at(locator, coordString) ⇒ Object

Doubleclicks on a link, button, checkbox or radio button. If the action causes a new page to load (like a link usually does), call waitForPageToLoad.

‘locator’ is an element locator ‘coordString’ is specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.



273
274
275
 
# File 'lib/selenium/openqa/selenium.rb', line 273

def double_click_at(locator,coordString)
    do_command("doubleClickAt", [locator,coordString,])
end

#drag_and_drop(locator, movementsString) ⇒ Object

Drags an element a certain distance and then drops it

‘locator’ is an element locator ‘movementsString’ is offset in pixels from the current location to which the element should be moved, e.g., “+70,-300”



1150
1151
1152
 
# File 'lib/selenium/openqa/selenium.rb', line 1150

def drag_and_drop(locator,movementsString)
    do_command("dragAndDrop", [locator,movementsString,])
end

#drag_and_drop_to_object(locatorOfObjectToBeDragged, locatorOfDragDestinationObject) ⇒ Object

Drags an element and drops it on another element

‘locatorOfObjectToBeDragged’ is an element to be dragged ‘locatorOfDragDestinationObject’ is an element whose location (i.e., whose center-most pixel) will be the point where locatorOfObjectToBeDragged is dropped



1159
1160
1161
 
# File 'lib/selenium/openqa/selenium.rb', line 1159

def drag_and_drop_to_object(locatorOfObjectToBeDragged,locatorOfDragDestinationObject)
    do_command("dragAndDropToObject", [locatorOfObjectToBeDragged,locatorOfDragDestinationObject,])
end

#dragdrop(locator, movementsString) ⇒ Object

deprecated - use dragAndDrop instead

‘locator’ is an element locator ‘movementsString’ is offset in pixels from the current location to which the element should be moved, e.g., “+70,-300”



1120
1121
1122
 
# File 'lib/selenium/openqa/selenium.rb', line 1120

def dragdrop(locator,movementsString)
    do_command("dragdrop", [locator,movementsString,])
end

#fire_event(locator, eventName) ⇒ Object

Explicitly simulate an event, to trigger the corresponding “onevent” handler.

‘locator’ is an element locator ‘eventName’ is the event name, e.g. “focus” or “blur”



283
284
285
 
# File 'lib/selenium/openqa/selenium.rb', line 283

def fire_event(locator,eventName)
    do_command("fireEvent", [locator,eventName,])
end

#get_alert ⇒ Object

Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts.

Getting an alert has the same effect as manually clicking OK. If an alert is generated but you do not get/verify it, the next Selenium action will fail. NOTE: under Selenium, JavaScript alerts will NOT pop up a visible alert dialog. NOTE: Selenium does NOT support JavaScript alerts that are generated in a page’s onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until someone manually clicks OK.



820
821
822
 
# File 'lib/selenium/openqa/selenium.rb', line 820

def get_alert()
    return get_string("getAlert", [])
end

#get_all_buttons ⇒ Object

Returns the IDs of all buttons on the page.

If a given button has no ID, it will appear as “” in this array.



1083
1084
1085
 
# File 'lib/selenium/openqa/selenium.rb', line 1083

def get_all_buttons()
    return get_string_array("getAllButtons", [])
end

#get_all_fields ⇒ Object

Returns the IDs of all input fields on the page.

If a given field has no ID, it will appear as “” in this array.



1103
1104
1105
 
# File 'lib/selenium/openqa/selenium.rb', line 1103

def get_all_fields()
    return get_string_array("getAllFields", [])
end

#get_all_links ⇒ Object

Returns the IDs of all links on the page.

If a given link has no ID, it will appear as “” in this array.



1093
1094
1095
 
# File 'lib/selenium/openqa/selenium.rb', line 1093

def get_all_links()
    return get_string_array("getAllLinks", [])
end

#get_all_window_ids ⇒ Object

Returns the IDs of all windows that the browser knows about.



1180
1181
1182
 
# File 'lib/selenium/openqa/selenium.rb', line 1180

def get_all_window_ids()
    return get_string_array("getAllWindowIds", [])
end

#get_all_window_names ⇒ Object

Returns the names of all windows that the browser knows about.



1187
1188
1189
 
# File 'lib/selenium/openqa/selenium.rb', line 1187

def get_all_window_names()
    return get_string_array("getAllWindowNames", [])
end

#get_all_window_titles ⇒ Object

Returns the titles of all windows that the browser knows about.



1194
1195
1196
 
# File 'lib/selenium/openqa/selenium.rb', line 1194

def get_all_window_titles()
    return get_string_array("getAllWindowTitles", [])
end

#get_attribute(attributeLocator) ⇒ Object

Gets the value of an element attribute.

‘attributeLocator’ is an element locator followed by an @ sign and then the name of the attribute, e.g. “foo@bar”



1036
1037
1038
 
# File 'lib/selenium/openqa/selenium.rb', line 1036

def get_attribute(attributeLocator)
    return get_string("getAttribute", [attributeLocator,])
end

#get_attribute_from_all_windows(attributeName) ⇒ Object

Returns every instance of some attribute from all known windows.

‘attributeName’ is name of an attribute on the windows



1111
1112
1113
 
# File 'lib/selenium/openqa/selenium.rb', line 1111

def get_attribute_from_all_windows(attributeName)
    return get_string_array("getAttributeFromAllWindows", [attributeName,])
end

#get_body_text ⇒ Object

Gets the entire text of the page.



885
886
887
 
# File 'lib/selenium/openqa/selenium.rb', line 885

def get_body_text()
    return get_string("getBodyText", [])
end

#get_boolean(verb, args) ⇒ Object

Raises:

  • (ValueError) 


207
208
209
210
211
212
213
214
215
216
 
# File 'lib/selenium/openqa/selenium.rb', line 207

def get_boolean(verb, args)
    boolstr = get_string(verb, args)
    if ("true" == boolstr)
        return true
    end
    if ("false" == boolstr)
        return false
    end
    raise ValueError, "result is neither 'true' nor 'false': " + boolstr
end

#get_boolean_array(verb, args) ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/selenium/openqa/selenium.rb', line 218

def get_boolean_array(verb, args)
    boolarr = get_string_array(verb, args)
    boolarr.length.times do |i|
        if ("true" == boolstr)
            boolarr[i] = true
            next
        end
        if ("false" == boolstr)
            boolarr[i] = false
            next
        end
        raise ValueError, "result is neither 'true' nor 'false': " + boolarr[i]
    end
    return boolarr
end

#get_confirmation ⇒ Object

Retrieves the message of a JavaScript confirmation dialog generated during the previous action.

By default, the confirm function will return true, having the same effect as manually clicking OK. This can be changed by prior execution of the chooseCancelOnNextConfirmation command. If an confirmation is generated but you do not get/verify it, the next Selenium action will fail.

NOTE: under Selenium, JavaScript confirmations will NOT pop up a visible dialog.

NOTE: Selenium does NOT support JavaScript confirmations that are generated in a page’s onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until you manually click OK.



846
847
848
 
# File 'lib/selenium/openqa/selenium.rb', line 846

def get_confirmation()
    return get_string("getConfirmation", [])
end

#get_cookie ⇒ Object

Return all cookies of the current page under test.



1388
1389
1390
 
# File 'lib/selenium/openqa/selenium.rb', line 1388

def get_cookie()
    return get_string("getCookie", [])
end

#get_cursor_position(locator) ⇒ Object

Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers.

Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to return the position of the last location of the cursor, even though the cursor is now gone from the page. This is filed as SEL-243.

This method will fail if the specified element isn’t an input element or textarea, or there is no cursor in the element.

‘locator’ is an element locator pointing to an input element or textarea



1276
1277
1278
 
# File 'lib/selenium/openqa/selenium.rb', line 1276

def get_cursor_position(locator)
    return get_number("getCursorPosition", [locator,])
end

#get_element_height(locator) ⇒ Object

Retrieves the height of an element

‘locator’ is an element locator pointing to an element



1263
1264
1265
 
# File 'lib/selenium/openqa/selenium.rb', line 1263

def get_element_height(locator)
    return get_number("getElementHeight", [locator,])
end

#get_element_index(locator) ⇒ Object

Get the relative index of an element to its parent (starting from 0). The comment node and empty text node will be ignored.

‘locator’ is an element locator pointing to an element



1221
1222
1223
 
# File 'lib/selenium/openqa/selenium.rb', line 1221

def get_element_index(locator)
    return get_number("getElementIndex", [locator,])
end

#get_element_position_left(locator) ⇒ Object

Retrieves the horizontal position of an element

‘locator’ is an element locator pointing to an element OR an element itself



1239
1240
1241
 
# File 'lib/selenium/openqa/selenium.rb', line 1239

def get_element_position_left(locator)
    return get_number("getElementPositionLeft", [locator,])
end

#get_element_position_top(locator) ⇒ Object

Retrieves the vertical position of an element

‘locator’ is an element locator pointing to an element OR an element itself



1247
1248
1249
 
# File 'lib/selenium/openqa/selenium.rb', line 1247

def get_element_position_top(locator)
    return get_number("getElementPositionTop", [locator,])
end

#get_element_width(locator) ⇒ Object

Retrieves the width of an element

‘locator’ is an element locator pointing to an element



1255
1256
1257
 
# File 'lib/selenium/openqa/selenium.rb', line 1255

def get_element_width(locator)
    return get_number("getElementWidth", [locator,])
end

#get_eval(script) ⇒ Object

Gets the result of evaluating the specified JavaScript snippet. The snippet may have multiple lines, but only the result of the last line will be returned.

Note that, by default, the snippet will run in the context of the “selenium” object itself, so this will refer to the Selenium object. Use window to refer to the window of your application, e.g. window.document.getElementById('foo') If you need to use a locator to refer to a single element in your application page, you can use this.browserbot.findElement("id=foo") where “id=foo” is your locator.

‘script’ is the JavaScript snippet to run



931
932
933
 
# File 'lib/selenium/openqa/selenium.rb', line 931

def get_eval(script)
    return get_string("getEval", [script,])
end

#get_expression(expression) ⇒ Object

Returns the specified expression.

This is useful because of JavaScript preprocessing. It is used to generate commands like assertExpression and waitForExpression.

‘expression’ is the value to return



1288
1289
1290
 
# File 'lib/selenium/openqa/selenium.rb', line 1288

def get_expression(expression)
    return get_string("getExpression", [expression,])
end

#get_html_source ⇒ Object

Returns the entire HTML source between the opening and closing “html” tags.



1202
1203
1204
 
# File 'lib/selenium/openqa/selenium.rb', line 1202

def get_html_source()
    return get_string("getHtmlSource", [])
end

#get_location ⇒ Object

Gets the absolute URL of the current page.



871
872
873
 
# File 'lib/selenium/openqa/selenium.rb', line 871

def get_location()
    return get_string("getLocation", [])
end

#get_mouse_speed ⇒ Object

Returns the number of pixels between “mousemove” events during dragAndDrop commands (default=10).



1141
1142
1143
 
# File 'lib/selenium/openqa/selenium.rb', line 1141

def get_mouse_speed()
    return get_number("getMouseSpeed", [])
end

#get_number(verb, args) ⇒ Object 



197
198
199
200
 
# File 'lib/selenium/openqa/selenium.rb', line 197

def get_number(verb, args)
    # Is there something I need to do here?
    return get_string(verb, args)
end

#get_number_array(verb, args) ⇒ Object 



202
203
204
205
 
# File 'lib/selenium/openqa/selenium.rb', line 202

def get_number_array(verb, args)
    # Is there something I need to do here?
    return get_string_array(verb, args)
end

#get_prompt ⇒ Object

Retrieves the message of a JavaScript question prompt dialog generated during the previous action.

Successful handling of the prompt requires prior execution of the answerOnNextPrompt command. If a prompt is generated but you do not get/verify it, the next Selenium action will fail. NOTE: under Selenium, JavaScript prompts will NOT pop up a visible dialog. NOTE: Selenium does NOT support JavaScript prompts that are generated in a page’s onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until someone manually clicks OK.



864
865
866
 
# File 'lib/selenium/openqa/selenium.rb', line 864

def get_prompt()
    return get_string("getPrompt", [])
end

#get_select_options(selectLocator) ⇒ Object

Gets all option labels in the specified select drop-down.

‘selectLocator’ is an element locator identifying a drop-down menu



1028
1029
1030
 
# File 'lib/selenium/openqa/selenium.rb', line 1028

def get_select_options(selectLocator)
    return get_string_array("getSelectOptions", [selectLocator,])
end

#get_selected_id(selectLocator) ⇒ Object

Gets option element ID for selected option in the specified select element.

‘selectLocator’ is an element locator identifying a drop-down menu



1012
1013
1014
 
# File 'lib/selenium/openqa/selenium.rb', line 1012

def get_selected_id(selectLocator)
    return get_string("getSelectedId", [selectLocator,])
end

#get_selected_ids(selectLocator) ⇒ Object

Gets all option element IDs for selected options in the specified select or multi-select element.

‘selectLocator’ is an element locator identifying a drop-down menu



1004
1005
1006
 
# File 'lib/selenium/openqa/selenium.rb', line 1004

def get_selected_ids(selectLocator)
    return get_string_array("getSelectedIds", [selectLocator,])
end

#get_selected_index(selectLocator) ⇒ Object

Gets option index (option number, starting at 0) for selected option in the specified select element.

‘selectLocator’ is an element locator identifying a drop-down menu



996
997
998
 
# File 'lib/selenium/openqa/selenium.rb', line 996

def get_selected_index(selectLocator)
    return get_string("getSelectedIndex", [selectLocator,])
end

#get_selected_indexes(selectLocator) ⇒ Object

Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.

‘selectLocator’ is an element locator identifying a drop-down menu



988
989
990
 
# File 'lib/selenium/openqa/selenium.rb', line 988

def get_selected_indexes(selectLocator)
    return get_string_array("getSelectedIndexes", [selectLocator,])
end

#get_selected_label(selectLocator) ⇒ Object

Gets option label (visible text) for selected option in the specified select element.

‘selectLocator’ is an element locator identifying a drop-down menu



964
965
966
 
# File 'lib/selenium/openqa/selenium.rb', line 964

def get_selected_label(selectLocator)
    return get_string("getSelectedLabel", [selectLocator,])
end

#get_selected_labels(selectLocator) ⇒ Object

Gets all option labels (visible text) for selected options in the specified select or multi-select element.

‘selectLocator’ is an element locator identifying a drop-down menu



956
957
958
 
# File 'lib/selenium/openqa/selenium.rb', line 956

def get_selected_labels(selectLocator)
    return get_string_array("getSelectedLabels", [selectLocator,])
end

#get_selected_value(selectLocator) ⇒ Object

Gets option value (value attribute) for selected option in the specified select element.

‘selectLocator’ is an element locator identifying a drop-down menu



980
981
982
 
# File 'lib/selenium/openqa/selenium.rb', line 980

def get_selected_value(selectLocator)
    return get_string("getSelectedValue", [selectLocator,])
end

#get_selected_values(selectLocator) ⇒ Object

Gets all option values (value attributes) for selected options in the specified select or multi-select element.

‘selectLocator’ is an element locator identifying a drop-down menu



972
973
974
 
# File 'lib/selenium/openqa/selenium.rb', line 972

def get_selected_values(selectLocator)
    return get_string_array("getSelectedValues", [selectLocator,])
end

#get_speed ⇒ Object

Get execution speed (i.e., get the millisecond length of the delay following each selenium operation). By default, there is no such delay, i.e., the delay is 0 milliseconds.

See also setSpeed.



490
491
492
 
# File 'lib/selenium/openqa/selenium.rb', line 490

def get_speed()
    do_command("getSpeed", [])
end

#get_string(verb, args) ⇒ Object 



168
169
170
171
 
# File 'lib/selenium/openqa/selenium.rb', line 168

def get_string(verb, args)
    result = do_command(verb, args)
    return result[3..result.length]
end

#get_string_array(verb, args) ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/selenium/openqa/selenium.rb', line 173

def get_string_array(verb, args)
    csv = get_string(verb, args)
    token = ""
    tokens = []
    escape = false
    csv.split(//).each do |letter|
        if escape
            token = token + letter
            escape = false
            next
        end
        if (letter == '\\')
            escape = true
        elsif (letter == ',')
            tokens.push(token)
            token = ""
        else
            token = token + letter
        end
    end
    tokens.push(token)
    return tokens
end

#get_table(tableCellAddress) ⇒ Object

Gets the text from a cell of a table. The cellAddress syntax tableLocator.row.column, where row and column start at 0.

‘tableCellAddress’ is a cell address, e.g. “foo.1.4”



948
949
950
 
# File 'lib/selenium/openqa/selenium.rb', line 948

def get_table(tableCellAddress)
    return get_string("getTable", [tableCellAddress,])
end

#get_text(locator) ⇒ Object

Gets the text of an element. This works for any element that contains text. This command uses either the textContent (Mozilla-like browsers) or the innerText (IE-like browsers) of the element, which is the rendered text shown to the user.

‘locator’ is an element locator



906
907
908
 
# File 'lib/selenium/openqa/selenium.rb', line 906

def get_text(locator)
    return get_string("getText", [locator,])
end

#get_title ⇒ Object

Gets the title of the current page.



878
879
880
 
# File 'lib/selenium/openqa/selenium.rb', line 878

def get_title()
    return get_string("getTitle", [])
end

#get_value(locator) ⇒ Object

Gets the (whitespace-trimmed) value of an input field (or anything else with a value parameter). For checkbox/radio elements, the value will be “on” or “off” depending on whether the element is checked or not.

‘locator’ is an element locator



895
896
897
 
# File 'lib/selenium/openqa/selenium.rb', line 895

def get_value(locator)
    return get_string("getValue", [locator,])
end

#get_whether_this_frame_match_frame_expression(currentFrameString, target) ⇒ Object

Determine whether current/locator identify the frame containing this running code.

This is useful in proxy injection mode, where this code runs in every browser frame and window, and sometimes the selenium server needs to identify the “current” frame. In this case, when the test calls selectFrame, this routine is called for each frame to figure out which one has been selected. The selected frame will return true, while all others will return false.

‘currentFrameString’ is starting frame ‘target’ is new frame (which might be relative to the current one)



684
685
686
 
# File 'lib/selenium/openqa/selenium.rb', line 684

def get_whether_this_frame_match_frame_expression(currentFrameString,target)
    return get_boolean("getWhetherThisFrameMatchFrameExpression", [currentFrameString,target,])
end

#get_whether_this_window_match_window_expression(currentWindowString, target) ⇒ Object

Determine whether currentWindowString plus target identify the window containing this running code.

This is useful in proxy injection mode, where this code runs in every browser frame and window, and sometimes the selenium server needs to identify the “current” window. In this case, when the test calls selectWindow, this routine is called for each window to figure out which one has been selected. The selected window will return true, while all others will return false.

‘currentWindowString’ is starting window ‘target’ is new window (which might be relative to the current one, e.g., “_parent”)



700
701
702
 
# File 'lib/selenium/openqa/selenium.rb', line 700

def get_whether_this_window_match_window_expression(currentWindowString,target)
    return get_boolean("getWhetherThisWindowMatchWindowExpression", [currentWindowString,target,])
end

#get_xpath_count(xpath) ⇒ Object

Returns the number of nodes that match the specified xpath, eg. “//table” would give the number of tables.

‘xpath’ is the xpath expression to evaluate. do NOT wrap this expression in a ‘count()’ function; we will do that for you.



1297
1298
1299
 
# File 'lib/selenium/openqa/selenium.rb', line 1297

def get_xpath_count(xpath)
    return get_number("getXpathCount", [xpath,])
end

#go_back ⇒ Object

Simulates the user clicking the “back” button on their browser.



752
753
754
 
# File 'lib/selenium/openqa/selenium.rb', line 752

def go_back()
    do_command("goBack", [])
end

#highlight(locator) ⇒ Object

Briefly changes the backgroundColor of the specified element yellow. Useful for debugging.

‘locator’ is an element locator



914
915
916
 
# File 'lib/selenium/openqa/selenium.rb', line 914

def highlight(locator)
    do_command("highlight", [locator,])
end

#is_alert_present ⇒ Object

Has an alert occurred?

This function never throws an exception



779
780
781
 
# File 'lib/selenium/openqa/selenium.rb', line 779

def is_alert_present()
    return get_boolean("isAlertPresent", [])
end

#is_checked(locator) ⇒ Object

Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn’t exist or isn’t a toggle-button.

‘locator’ is an element locator pointing to a checkbox or radio button



939
940
941
 
# File 'lib/selenium/openqa/selenium.rb', line 939

def is_checked(locator)
    return get_boolean("isChecked", [locator,])
end

#is_confirmation_present ⇒ Object

Has confirm() been called?

This function never throws an exception



803
804
805
 
# File 'lib/selenium/openqa/selenium.rb', line 803

def is_confirmation_present()
    return get_boolean("isConfirmationPresent", [])
end

#is_editable(locator) ⇒ Object

Determines whether the specified input element is editable, ie hasn’t been disabled. This method will fail if the specified element isn’t an input element.

‘locator’ is an element locator



1073
1074
1075
 
# File 'lib/selenium/openqa/selenium.rb', line 1073

def is_editable(locator)
    return get_boolean("isEditable", [locator,])
end

#is_element_present(locator) ⇒ Object

Verifies that the specified element is somewhere on the page.

‘locator’ is an element locator



1052
1053
1054
 
# File 'lib/selenium/openqa/selenium.rb', line 1052

def is_element_present(locator)
    return get_boolean("isElementPresent", [locator,])
end

#is_ordered(locator1, locator2) ⇒ Object

Check if these two elements have same parent and are ordered siblings in the DOM. Two same elements will not be considered ordered.

‘locator1’ is an element locator pointing to the first element ‘locator2’ is an element locator pointing to the second element



1231
1232
1233
 
# File 'lib/selenium/openqa/selenium.rb', line 1231

def is_ordered(locator1,locator2)
    return get_boolean("isOrdered", [locator1,locator2,])
end

#is_prompt_present ⇒ Object

Has a prompt occurred?

This function never throws an exception



791
792
793
 
# File 'lib/selenium/openqa/selenium.rb', line 791

def is_prompt_present()
    return get_boolean("isPromptPresent", [])
end

#is_something_selected(selectLocator) ⇒ Object

Determines whether some option in a drop-down menu is selected.

‘selectLocator’ is an element locator identifying a drop-down menu



1020
1021
1022
 
# File 'lib/selenium/openqa/selenium.rb', line 1020

def is_something_selected(selectLocator)
    return get_boolean("isSomethingSelected", [selectLocator,])
end

#is_text_present(pattern) ⇒ Object

Verifies that the specified text pattern appears somewhere on the rendered page shown to the user.

‘pattern’ is a pattern to match with the text of the page



1044
1045
1046
 
# File 'lib/selenium/openqa/selenium.rb', line 1044

def is_text_present(pattern)
    return get_boolean("isTextPresent", [pattern,])
end

#is_visible(locator) ⇒ Object

Determines if the specified element is visible. An element can be rendered invisible by setting the CSS “visibility” property to “hidden”, or the “display” property to “none”, either for the element itself or one if its ancestors. This method will fail if the element is not present.

‘locator’ is an element locator



1064
1065
1066
 
# File 'lib/selenium/openqa/selenium.rb', line 1064

def is_visible(locator)
    return get_boolean("isVisible", [locator,])
end

#key_down(locator, keySequence) ⇒ Object

Simulates a user pressing a key (without releasing it yet).

‘locator’ is an element locator ‘keySequence’ is Either be a string(“" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: ”w“, ”119“.



357
358
359
 
# File 'lib/selenium/openqa/selenium.rb', line 357

def key_down(locator,keySequence)
    do_command("keyDown", [locator,keySequence,])
end

#key_press(locator, keySequence) ⇒ Object

Simulates a user pressing and releasing a key.

‘locator’ is an element locator ‘keySequence’ is Either be a string(“" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: ”w“, ”119“.



292
293
294
 
# File 'lib/selenium/openqa/selenium.rb', line 292

def key_press(locator,keySequence)
    do_command("keyPress", [locator,keySequence,])
end

#key_up(locator, keySequence) ⇒ Object

Simulates a user releasing a key.

‘locator’ is an element locator ‘keySequence’ is Either be a string(“" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: ”w“, ”119“.



366
367
368
 
# File 'lib/selenium/openqa/selenium.rb', line 366

def key_up(locator,keySequence)
    do_command("keyUp", [locator,keySequence,])
end

#meta_key_down ⇒ Object

Press the meta key and hold it down until doMetaUp() is called or a new page is loaded.



313
314
315
 
# File 'lib/selenium/openqa/selenium.rb', line 313

def meta_key_down()
    do_command("metaKeyDown", [])
end

#meta_key_up ⇒ Object

Release the meta key.



320
321
322
 
# File 'lib/selenium/openqa/selenium.rb', line 320

def meta_key_up()
    do_command("metaKeyUp", [])
end

#mouse_down(locator) ⇒ Object

Simulates a user pressing the mouse button (without releasing it yet) on the specified element.

‘locator’ is an element locator



391
392
393
 
# File 'lib/selenium/openqa/selenium.rb', line 391

def mouse_down(locator)
    do_command("mouseDown", [locator,])
end

#mouse_down_at(locator, coordString) ⇒ Object

Simulates a user pressing the mouse button (without releasing it yet) at the specified location.

‘locator’ is an element locator ‘coordString’ is specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.



401
402
403
 
# File 'lib/selenium/openqa/selenium.rb', line 401

def mouse_down_at(locator,coordString)
    do_command("mouseDownAt", [locator,coordString,])
end

#mouse_move(locator) ⇒ Object

Simulates a user pressing the mouse button (without releasing it yet) on the specified element.

‘locator’ is an element locator



429
430
431
 
# File 'lib/selenium/openqa/selenium.rb', line 429

def mouse_move(locator)
    do_command("mouseMove", [locator,])
end

#mouse_move_at(locator, coordString) ⇒ Object

Simulates a user pressing the mouse button (without releasing it yet) on the specified element.

‘locator’ is an element locator ‘coordString’ is specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.



439
440
441
 
# File 'lib/selenium/openqa/selenium.rb', line 439

def mouse_move_at(locator,coordString)
    do_command("mouseMoveAt", [locator,coordString,])
end

#mouse_out(locator) ⇒ Object

Simulates a user moving the mouse pointer away from the specified element.

‘locator’ is an element locator



382
383
384
 
# File 'lib/selenium/openqa/selenium.rb', line 382

def mouse_out(locator)
    do_command("mouseOut", [locator,])
end

#mouse_over(locator) ⇒ Object

Simulates a user hovering a mouse over the specified element.

‘locator’ is an element locator



374
375
376
 
# File 'lib/selenium/openqa/selenium.rb', line 374

def mouse_over(locator)
    do_command("mouseOver", [locator,])
end

#mouse_up(locator) ⇒ Object

Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) on the specified element.

‘locator’ is an element locator



410
411
412
 
# File 'lib/selenium/openqa/selenium.rb', line 410

def mouse_up(locator)
    do_command("mouseUp", [locator,])
end

#mouse_up_at(locator, coordString) ⇒ Object

Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) at the specified location.

‘locator’ is an element locator ‘coordString’ is specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.



420
421
422
 
# File 'lib/selenium/openqa/selenium.rb', line 420

def mouse_up_at(locator,coordString)
    do_command("mouseUpAt", [locator,coordString,])
end

#open(url) ⇒ Object

Opens an URL in the test frame. This accepts both relative and absolute URLs.

The “open” command waits for the page to load before proceeding, ie. the “AndWait” suffix is implicit.

Note: The URL must be on the same domain as the runner HTML due to security restrictions in the browser (Same Origin Policy). If you need to open an URL on another domain, use the Selenium Server to start a new browser session on that domain.

‘url’ is the URL to open; may be relative or absolute



605
606
607
 
# File 'lib/selenium/openqa/selenium.rb', line 605

def open(url)
    do_command("open", [url,])
end

#open_window(url, windowID) ⇒ Object

Opens a popup window (if a window with that ID isn’t already open). After opening the window, you’ll need to select it using the selectWindow command.

This command can also be a useful workaround for bug SEL-339. In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the “onLoad” event, for example). In those cases, you can force Selenium to notice the open window’s name by using the Selenium openWindow command, using an empty (blank) url, like this: openWindow(“”, “myFunnyWindow”).

‘url’ is the URL to open, which can be blank ‘windowID’ is the JavaScript window ID of the window to select



621
622
623
 
# File 'lib/selenium/openqa/selenium.rb', line 621

def open_window(url,windowID)
    do_command("openWindow", [url,windowID,])
end

#refresh ⇒ Object

Simulates the user clicking the “Refresh” button on their browser.



759
760
761
 
# File 'lib/selenium/openqa/selenium.rb', line 759

def refresh()
    do_command("refresh", [])
end

#remove_all_selections(locator) ⇒ Object

Unselects all of the selected options in a multi-select element.

‘locator’ is an element locator identifying a multi-select box



579
580
581
 
# File 'lib/selenium/openqa/selenium.rb', line 579

def remove_all_selections(locator)
    do_command("removeAllSelections", [locator,])
end

#remove_selection(locator, optionLocator) ⇒ Object

Remove a selection from the set of selected options in a multi-select element using an option locator.

‘locator’ is an element locator identifying a multi-select box ‘optionLocator’ is an option locator (a label by default)

See Also:

  • for details of option locators


571
572
573
 
# File 'lib/selenium/openqa/selenium.rb', line 571

def remove_selection(locator,optionLocator)
    do_command("removeSelection", [locator,optionLocator,])
end

#run_script(script) ⇒ Object

Creates a new “script” tag in the body of the current test window, and adds the specified text into the body of the command. Scripts run in this way can often be debugged more easily than scripts executed using Selenium’s “getEval” command. Beware that JS exceptions thrown in these script tags aren’t managed by Selenium, so you should probably wrap your script in try/catch blocks if there is any chance that the script will throw an exception.

‘script’ is the JavaScript snippet to run



1432
1433
1434
 
# File 'lib/selenium/openqa/selenium.rb', line 1432

def run_script(script)
    do_command("runScript", [script,])
end

#select(selectLocator, optionLocator) ⇒ Object

Select an option from a drop-down using an option locator.

Option locators provide different ways of specifying options of an HTML Select element (e.g. for selecting a specific option, or for asserting that the selected option satisfies a specification). There are several forms of Select Option Locator.

  • label=labelPattern:

matches options based on their labels, i.e. the visible text. (This is the default.)

matches options based on their values.

  • value=other

  • id=id:

matches options based on their ids.

  • id=option1

  • index=index:

matches an option based on its index (offset from zero).

  • index=2

If no option locator prefix is provided, the default behaviour is to match on label.

‘selectLocator’ is an element locator identifying a drop-down menu ‘optionLocator’ is an option locator (a label by default)



549
550
551
 
# File 'lib/selenium/openqa/selenium.rb', line 549

def select(selectLocator,optionLocator)
    do_command("select", [selectLocator,optionLocator,])
end

#select_frame(locator) ⇒ Object

Selects a frame within the current window. (You may invoke this command multiple times to select nested frames.) To select the parent frame, use “relative=parent” as a locator; to select the top frame, use “relative=top”. You can also select a frame by its 0-based index number; select the first frame with “index=0”, or the third frame with “index=2”.

You may also use a DOM expression to identify the frame you want directly, like this: dom=frames["main"].frames["subframe"]

‘locator’ is an element locator identifying a frame or iframe



668
669
670
 
# File 'lib/selenium/openqa/selenium.rb', line 668

def select_frame(locator)
    do_command("selectFrame", [locator,])
end

#select_window(windowID) ⇒ Object

Selects a popup window; once a popup window has been selected, all commands go to that window. To select the main window again, use null as the target.

Note that there is a big difference between a window’s internal JavaScript “name” property and the “title” of a given window’s document (which is normally what you actually see, as an end user, in the title bar of the window). The “name” is normally invisible to the end-user; it’s the second parameter “windowName” passed to the JavaScript method window.open(url, windowName, windowFeatures, replaceFlag) (which selenium intercepts). Selenium has several strategies for finding the window object referred to by the “windowID” parameter. 1.) if windowID is null, (or the string “null”) then it is assumed the user is referring to the original window instantiated by the browser). 2.) if the value of the “windowID” parameter is a JavaScript variable name in the current application window, then it is assumed that this variable contains the return value from a call to the JavaScript window.open() method. 3.) Otherwise, selenium looks in a hash it maintains that maps string names to window “names”. 4.) If that fails, we’ll try looping over all of the known windows to try to find the appropriate “title”. Since “title” is not necessarily unique, this may have unexpected behavior. If you’re having trouble figuring out what is the name of a window that you want to manipulate, look at the selenium log messages which identify the names of windows created via window.open (and therefore intercepted by selenium). You will see messages like the following for each window as it is opened: debug: window.open call intercepted; window ID (which you can use with selectWindow()) is "myNewWindow" In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the “onLoad” event, for example). (This is bug SEL-339.) In those cases, you can force Selenium to notice the open window’s name by using the Selenium openWindow command, using an empty (blank) url, like this: openWindow(“”, “myFunnyWindow”).

‘windowID’ is the JavaScript window ID of the window to select



652
653
654
 
# File 'lib/selenium/openqa/selenium.rb', line 652

def select_window(windowID)
    do_command("selectWindow", [windowID,])
end

#set_browser_log_level(logLevel) ⇒ Object

Sets the threshold for browser-side logging messages; log messages beneath this threshold will be discarded. Valid logLevel strings are: “debug”, “info”, “warn”, “error” or “off”. To see the browser logs, you need to either show the log window in GUI mode, or enable browser-side logging in Selenium RC.

‘logLevel’ is one of the following: “debug”, “info”, “warn”, “error” or “off”



1418
1419
1420
 
# File 'lib/selenium/openqa/selenium.rb', line 1418

def set_browser_log_level(logLevel)
    do_command("setBrowserLogLevel", [logLevel,])
end

#set_context(context) ⇒ Object

Writes a message to the status bar and adds a note to the browser-side log.

‘context’ is the message to be sent to the browser



1463
1464
1465
 
# File 'lib/selenium/openqa/selenium.rb', line 1463

def set_context(context)
    do_command("setContext", [context,])
end

#set_cursor_position(locator, position) ⇒ Object

Moves the text cursor to the specified position in the given input element or textarea. This method will fail if the specified element isn’t an input element or textarea.

‘locator’ is an element locator pointing to an input element or textarea ‘position’ is the numerical position of the cursor in the field; position should be 0 to move the position to the beginning of the field. You can also set the cursor to -1 to move it to the end of the field.



1212
1213
1214
 
# File 'lib/selenium/openqa/selenium.rb', line 1212

def set_cursor_position(locator,position)
    do_command("setCursorPosition", [locator,position,])
end

#set_mouse_speed(pixels) ⇒ Object

Configure the number of pixels between “mousemove” events during dragAndDrop commands (default=10). Setting this value to 0 means that we’ll send a “mousemove” event to every single pixel in between the start location and the end location; that can be very slow, and may cause some browsers to force the JavaScript to timeout. If the mouse speed is greater than the distance between the two dragged objects, we’ll just send one “mousemove” at the start location and then one final one at the end location.

‘pixels’ is the number of pixels between “mousemove” events



1134
1135
1136
 
# File 'lib/selenium/openqa/selenium.rb', line 1134

def set_mouse_speed(pixels)
    do_command("setMouseSpeed", [pixels,])
end

#set_speed(value) ⇒ Object

Set execution speed (i.e., set the millisecond length of a delay which will follow each selenium operation). By default, there is no such delay, i.e., the delay is 0 milliseconds.

‘value’ is the number of milliseconds to pause after operation



480
481
482
 
# File 'lib/selenium/openqa/selenium.rb', line 480

def set_speed(value)
    do_command("setSpeed", [value,])
end

#set_timeout(timeout) ⇒ Object

Specifies the amount of time that Selenium will wait for actions to complete.

Actions that require waiting include “open” and the “waitFor*” actions.

The default timeout is 30 seconds.

‘timeout’ is a timeout in milliseconds, after which the action will return with an error



1350
1351
1352
 
# File 'lib/selenium/openqa/selenium.rb', line 1350

def set_timeout(timeout)
    do_command("setTimeout", [timeout,])
end

#shift_key_down ⇒ Object

Press the shift key and hold it down until doShiftUp() is called or a new page is loaded.



299
300
301
 
# File 'lib/selenium/openqa/selenium.rb', line 299

def shift_key_down()
    do_command("shiftKeyDown", [])
end

#shift_key_up ⇒ Object

Release the shift key.



306
307
308
 
# File 'lib/selenium/openqa/selenium.rb', line 306

def shift_key_up()
    do_command("shiftKeyUp", [])
end

#start ⇒ Object 



137
138
139
140
 
# File 'lib/selenium/openqa/selenium.rb', line 137

def start()
    result = get_string("getNewBrowserSession", [@browserStartCommand, @browserURL])
    @session_id = result
end

#stop ⇒ Object 



142
143
144
145
 
# File 'lib/selenium/openqa/selenium.rb', line 142

def stop()
    do_command("testComplete", [])
    @session_id = nil
end

#submit(formLocator) ⇒ Object

Submit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input “Search” forms.

‘formLocator’ is an element locator for the form you want to submit



588
589
590
 
# File 'lib/selenium/openqa/selenium.rb', line 588

def submit(formLocator)
    do_command("submit", [formLocator,])
end

#to_s ⇒ Object 



133
134
135
 
# File 'lib/selenium/openqa/selenium.rb', line 133

def to_s
    "SeleniumDriver"
end

#type(locator, value) ⇒ Object

Sets the value of an input field, as though you typed it in.

Can also be used to set the value of combo boxes, check boxes, etc. In these cases, value should be the value of the option selected, not the visible text.

‘locator’ is an element locator ‘value’ is the value to type



452
453
454
 
# File 'lib/selenium/openqa/selenium.rb', line 452

def type(locator,value)
    do_command("type", [locator,value,])
end

#type_keys(locator, value) ⇒ Object

Simulates keystroke events on the specified element, as though you typed the value key-by-key.

This is a convenience method for calling keyDown, keyUp, keyPress for every character in the specified string; this is useful for dynamic UI widgets (like auto-completing combo boxes) that require explicit key events. Unlike the simple “type” command, which forces the specified value into the page directly, this command may or may not have any visible effect, even in cases where typing keys would normally have a visible effect. For example, if you use “typeKeys” on a form element, you may or may not see the results of what you typed in the field. In some cases, you may need to use the simple “type” command to set the value of the field and then the “typeKeys” command to send the keystroke events corresponding to what you just typed.

‘locator’ is an element locator ‘value’ is the value to type



471
472
473
 
# File 'lib/selenium/openqa/selenium.rb', line 471

def type_keys(locator,value)
    do_command("typeKeys", [locator,value,])
end

#uncheck(locator) ⇒ Object

Uncheck a toggle-button (checkbox/radio)

‘locator’ is an element locator



506
507
508
 
# File 'lib/selenium/openqa/selenium.rb', line 506

def uncheck(locator)
    do_command("uncheck", [locator,])
end

#wait_for_condition(script, timeout) ⇒ Object

Runs the specified JavaScript snippet repeatedly until it evaluates to “true”. The snippet may have multiple lines, but only the result of the last line will be considered.

Note that, by default, the snippet will be run in the runner’s test window, not in the window of your application. To get the window of your application, you can use the JavaScript snippet selenium.browserbot.getCurrentWindow(), and then run your JavaScript in there

‘script’ is the JavaScript snippet to run ‘timeout’ is a timeout in milliseconds, after which this command will return with an error



1338
1339
1340
 
# File 'lib/selenium/openqa/selenium.rb', line 1338

def wait_for_condition(script,timeout)
    do_command("waitForCondition", [script,timeout,])
end

#wait_for_frame_to_load(frameAddress, timeout) ⇒ Object

Waits for a new frame to load.

Selenium constantly keeps track of new pages and frames loading, and sets a “newPageLoaded” flag when it first notices a page load.

See waitForPageToLoad for more information.

‘frameAddress’ is FrameAddress from the server side ‘timeout’ is a timeout in milliseconds, after which this command will return with an error



1381
1382
1383
 
# File 'lib/selenium/openqa/selenium.rb', line 1381

def wait_for_frame_to_load(frameAddress,timeout)
    do_command("waitForFrameToLoad", [frameAddress,timeout,])
end

#wait_for_page_to_load(timeout) ⇒ Object

Waits for a new page to load.

You can use this command instead of the “AndWait” suffixes, “clickAndWait”, “selectAndWait”, “typeAndWait” etc. (which are only available in the JS API). Selenium constantly keeps track of new pages loading, and sets a “newPageLoaded” flag when it first notices a page load. Running any other Selenium command after turns the flag to false. Hence, if you want to wait for a page to load, you must wait immediately after a Selenium command that caused a page-load.

‘timeout’ is a timeout in milliseconds, after which this command will return with an error



1366
1367
1368
 
# File 'lib/selenium/openqa/selenium.rb', line 1366

def wait_for_page_to_load(timeout)
    do_command("waitForPageToLoad", [timeout,])
end

#wait_for_pop_up(windowID, timeout) ⇒ Object

Waits for a popup window to appear and load up.

‘windowID’ is the JavaScript window ID of the window that will appear ‘timeout’ is a timeout in milliseconds, after which the action will return with an error



709
710
711
 
# File 'lib/selenium/openqa/selenium.rb', line 709

def wait_for_pop_up(windowID,timeout)
    do_command("waitForPopUp", [windowID,timeout,])
end

#window_focus ⇒ Object

Gives focus to the currently selected window



1166
1167
1168
 
# File 'lib/selenium/openqa/selenium.rb', line 1166

def window_focus()
    do_command("windowFocus", [])
end

#window_maximize ⇒ Object

Resize currently selected window to take up the entire screen



1173
1174
1175
 
# File 'lib/selenium/openqa/selenium.rb', line 1173

def window_maximize()
    do_command("windowMaximize", [])
end