Class | Selenium::SeleneseInterpreter
In: | selenium.rb
Parent: | Object

### Methods

add_selection answer_on_next_prompt check choose_cancel_on_next_confirmation click close do_command fire_event get_alert get_all_buttons get_all_fields get_all_links get_attribute get_body_text get_boolean get_boolean_array get_confirmation get_cursor_position get_eval get_expression get_html_source get_location get_number get_number_array get_prompt get_select_options get_selected_id get_selected_ids get_selected_index get_selected_indexes get_selected_label get_selected_labels get_selected_value get_selected_values get_string get_string_array get_table get_text get_title get_value go_back is_alert_present is_checked is_confirmation_present is_editable is_element_present is_prompt_present is_something_selected is_text_present is_visible key_down key_press key_up mouse_down mouse_over new open refresh remove_selection select select_window set_context set_cursor_position set_timeout start stop submit to_s type uncheck wait_for_condition wait_for_page_to_load wait_for_pop_up

### Included Modules

Selenium

### Public Class methods

new(server_host, server_port, browserStartCommand, browserURL, timeout=30000)

### Public Instance methods

add_selection(locator,optionLocator)

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

@see doSelect for details of option locators

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

answer_on_next_prompt(answer)

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

check(locator)

Check a toggle-button (checkbox/radio)

‘locator’ is an element locator

choose_cancel_on_next_confirmation()

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.

click(locator)

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

close()

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

do_command(verb, args)
fire_event(locator,eventName)

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"

get_alert()

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.

get_all_buttons()

Returns the IDs of all buttons on the page.

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

get_all_fields()

Returns the IDs of all input fields on the page.

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

get_all_links()

Returns the IDs of all links on the page.

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

get_attribute(attributeLocator)

Gets the value of an element attribute.

‘attributeLocator’ is an element locator followed by an

get_body_text()

Gets the entire text of the page.

get_boolean(verb, args)
get_boolean_array(verb, args)
get_confirmation()

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.

get_cursor_position(locator)

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

get_eval(script)

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, and `window` will refer to the top-level runner test window, not the window of your application. If you need a reference to the window of your application, you can refer to `this.browserbot.getCurrentWindow()` and if you need to use a locator to refer to a single element in your application page, you can use `this.page().findElement("foo")` where "foo" is your locator.

‘script’ is the JavaScript snippet to run

get_expression(expression)

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

get_html_source()

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

get_location()

Gets the absolute URL of the current page.

get_number(verb, args)
get_number_array(verb, args)
get_prompt()

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.

get_select_options(selectLocator)

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

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

get_selected_id(selectLocator)

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

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

get_selected_ids(selectLocator)

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

get_selected_index(selectLocator)

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

get_selected_indexes(selectLocator)

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

get_selected_label(selectLocator)

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

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

get_selected_labels(selectLocator)

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

get_selected_value(selectLocator)

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

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

get_selected_values(selectLocator)

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

get_string(verb, args)
get_string_array(verb, args)
get_table(tableCellAddress)

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"

get_text(locator)

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

get_title()

Gets the title of the current page.

get_value(locator)

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

go_back()

Simulates the user clicking the "back" button on their browser.

is_alert_present()

Has an alert occurred?

This function never throws an exception

is_checked(locator)

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

is_confirmation_present()

Has confirm() been called?

This function never throws an exception

is_editable(locator)

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

is_element_present(locator)

Verifies that the specified element is somewhere on the page.

‘locator’ is an element locator

is_prompt_present()

Has a prompt occurred?

This function never throws an exception

is_something_selected(selectLocator)

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

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

is_text_present(pattern)

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

is_visible(locator)

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

key_down(locator,keycode)

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

‘locator’ is an element locator ‘keycode’ is the numeric keycode of the key to be pressed, normally the ASCII value of that key.

key_press(locator,keycode)

Simulates a user pressing and releasing a key.

‘locator’ is an element locator ‘keycode’ is the numeric keycode of the key to be pressed, normally the ASCII value of that key.

key_up(locator,keycode)

Simulates a user releasing a key.

‘locator’ is an element locator ‘keycode’ is the numeric keycode of the key to be released, normally the ASCII value of that key.

mouse_down(locator)

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

‘locator’ is an element locator

mouse_over(locator)

Simulates a user hovering a mouse over the specified element.

‘locator’ is an element locator

open(url)

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

refresh()

Simulates the user clicking the "Refresh" button on their browser.

remove_selection(locator,optionLocator)

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

@see doSelect for details of option locators

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

select(selectLocator,optionLocator)

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.)
        *    label=regexp:^[Oo]ther

- value=valuePattern::

        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)

select_window(windowID)

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.

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

set_context(context,logLevelThreshold)

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

If logLevelThreshold is specified, set the threshold for logging to that level (debug, info, warn, error). (Note that the browser-side logs will not be sent back to the server, and are invisible to the Client Driver.)

‘context’ is the message to be sent to the browser ‘logLevelThreshold’ is one of "debug", "info", "warn", "error", sets the threshold for browser-side logging

set_cursor_position(locator,position)

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.

set_timeout(timeout)

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

start()
stop()
submit(formLocator)

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

to_s()
type(locator,value)

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

uncheck(locator)

Uncheck a toggle-button (checkbox/radio)

‘locator’ is an element locator

wait_for_condition(script,timeout)

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

wait_for_page_to_load(timeout)

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

wait_for_pop_up(windowID,timeout)

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

[Validate]