Docs For Class Testing

__construct (Constructor) [line 310]

Testing_Selenium __construct(
string
$browser, string
$browserUrl, [string
$host = 'localhost'], [int
$port = 4444], [int
$timeout = 30000])

Constructor

Throws: Testing_Selenium_Exception
Access: public

Parameters:

string	`$browser`	—
string	`$browserUrl`	—
string	`$host`	—
int	`$port`	—
int	`$timeout`	—

[ Top ]

addSelection [line 826]

void addSelection(
string
$locator, string
$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
Access: public

Parameters:

string	`$locator`	—	an element locator identifying a multi-select box
string	`$optionLocator`	—	an option locator (a label by default)

[ Top ]

altKeyDown [line 477]

void altKeyDown(
)

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

Access: public

[ Top ]

altKeyUp [line 488]

void altKeyUp(
)

Release the alt key.

Access: public

[ Top ]

answerOnNextPrompt [line 1071]

void answerOnNextPrompt(
string
$answer)

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

Access: public

Parameters:

string $answer — the answer to give in response to the prompt pop-up

[ Top ]

check [line 724]

void check(
string
$locator)

Check a toggle-button (checkbox/radio)

Access: public

Parameters:

string $locator — an element locator

[ Top ]

chooseCancelOnNextConfirmation [line 1058]

void chooseCancelOnNextConfirmation(
)

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.

Access: public

[ Top ]

click [line 351]

void click(
string
$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.

Access: public

Parameters:

string $locator — an element locator

[ Top ]

clickAt [line 380]

void clickAt(
string
$locator, string
$coordString)

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.

Access: public

Parameters:

string	`$locator`	—	an element locator
string	`$coordString`	—	specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

[ Top ]

close [line 1105]

void close(
)

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

Access: public

[ Top ]

controlKeyDown [line 499]

void controlKeyDown(
)

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

Access: public

[ Top ]

controlKeyUp [line 510]

void controlKeyUp(
)

Release the control key.

Access: public

[ Top ]

createCookie [line 2021]

void createCookie(
string
$nameValuePair, string
$optionsString)

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.

Access: public

Parameters:

string	`$nameValuePair`	—	name and value of the cookie in a format "name=value"
string	`$optionsString`	—	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.

[ Top ]

deleteCookie [line 2034]

void deleteCookie(
string
$name, string
$path)

Delete a named cookie with specified path.

Access: public

Parameters:

string	`$name`	—	the name of the cookie to be deleted
string	`$path`	—	the path property of the cookie to be deleted

[ Top ]

doubleClick [line 365]

void doubleClick(
string
$locator)

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.

Access: public

Parameters:

string $locator — an element locator

[ Top ]

doubleClickAt [line 395]

void doubleClickAt(
string
$locator, string
$coordString)

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.

Access: public

Parameters:

string	`$locator`	—	an element locator
string	`$coordString`	—	specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

[ Top ]

dragAndDrop [line 1694]

void dragAndDrop(
string
$locator, string
$movementsString)

Drags an element a certain distance and then drops it

Access: public

Parameters:

string	`$locator`	—	an element locator
string	`$movementsString`	—	offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"

[ Top ]

dragAndDropToObject [line 1707]

void dragAndDropToObject(
string
$locatorOfObjectToBeDragged, string
$locatorOfDragDestinationObject)

Drags an element and drops it on another element

Access: public

Parameters:

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

[ Top ]

dragdrop [line 1649]

void dragdrop(
string
$locator, string
$movementsString)

deprecated - use dragAndDrop instead

Access: public

Parameters:

string	`$locator`	—	an element locator
string	`$movementsString`	—	offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"

[ Top ]

fireEvent [line 409]

void fireEvent(
string
$locator, string
$eventName)

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

Access: public

Parameters:

string	`$locator`	—	an element locator
string	`$eventName`	—	the event name, e.g. "focus" or "blur"

[ Top ]

getAlert [line 1184]

string getAlert(
)

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.

Return: The message of the most recent JavaScript alert
Access: public

[ Top ]

getAllButtons [line 1591]

array getAllButtons(
)

Returns the IDs of all buttons on the page.

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

Return: the IDs of all buttons on the page
Access: public

[ Top ]

getAllFields [line 1623]

array getAllFields(
)

Returns the IDs of all input fields on the page.

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

Return: the IDs of all field on the page
Access: public

[ Top ]

getAllLinks [line 1607]

array getAllLinks(
)

Returns the IDs of all links on the page.

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

Return: the IDs of all links on the page
Access: public

[ Top ]

getAllWindowIds [line 1743]

array getAllWindowIds(
)

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

Return: the IDs of all windows that the browser knows about.
Access: public

[ Top ]

getAllWindowNames [line 1755]

array getAllWindowNames(
)

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

Return: the names of all windows that the browser knows about.
Access: public

[ Top ]

getAllWindowTitles [line 1767]

array getAllWindowTitles(
)

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

Return: the titles of all windows that the browser knows about.
Access: public

[ Top ]

getAttribute [line 1518]

string getAttribute(
string
$attributeLocator)

Gets the value of an element attribute.

Return: the value of the specified attribute
Access: public

Parameters:

string $attributeLocator — an element locator followed by an

[ Top ]

getAttributeFromAllWindows [line 1636]

array getAttributeFromAllWindows(
string
$attributeName)

Returns every instance of some attribute from all known windows.

Return: the set of values of this attribute from all known windows.
Access: public

Parameters:

string $attributeName — name of an attribute on the windows

[ Top ]

getBodyText [line 1280]

string getBodyText(
)

Gets the entire text of the page.

Return: the entire text of the page
Access: public

[ Top ]

getConfirmation [line 1218]

string getConfirmation(
)

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.

Return: the message of the most recent JavaScript confirmation dialog
Access: public

[ Top ]

getCookie [line 2007]

string getCookie(
)

Return all cookies of the current page under test.

Return: all cookies of the current page under test
Access: public

[ Top ]

getCursorPosition [line 1894]

number getCursorPosition(
string
$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.

Return: the numerical position of the cursor in the field
Access: public

Parameters:

string $locator — an element locator pointing to an input element or textarea

[ Top ]

getElementHeight [line 1875]

number getElementHeight(
string
$locator)

Retrieves the height of an element

Return: height of an element in pixels
Access: public

Parameters:

string $locator — an element locator pointing to an element

[ Top ]

getElementIndex [line 1808]

number getElementIndex(
string
$locator)

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

Return: of relative index of the element to its parent (starting from 0)
Access: public

Parameters:

string $locator — an element locator pointing to an element

[ Top ]

getElementPositionLeft [line 1836]

number getElementPositionLeft(
string
$locator)

Retrieves the horizontal position of an element

Return: of pixels from the edge of the frame.
Access: public

Parameters:

string $locator — an element locator pointing to an element OR an element itself

[ Top ]

getElementPositionTop [line 1849]

number getElementPositionTop(
string
$locator)

Retrieves the vertical position of an element

Return: of pixels from the edge of the frame.
Access: public

Parameters:

string $locator — an element locator pointing to an element OR an element itself

[ Top ]

getElementWidth [line 1862]

number getElementWidth(
string
$locator)

Retrieves the width of an element

Return: width of an element in pixels
Access: public

Parameters:

string $locator — an element locator pointing to an element

[ Top ]

getEval [line 1348]

string getEval(
string
$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.browserbot.findElement("foo")

where "foo" is your locator.

Return: the results of evaluating the snippet
Access: public

Parameters:

string $script — the JavaScript snippet to run

[ Top ]

getExpression [line 1934]

string getExpression(
string
$expression)

Returns the specified expression.

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

Return: the value passed in
Access: public

Parameters:

string $expression — the value to return

[ Top ]

getHtmlSource [line 1780]

string getHtmlSource(
)

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

Return: the entire HTML source
Access: public

[ Top ]

getLocation [line 1256]

string getLocation(
)

Gets the absolute URL of the current page.

Return: the absolute URL of the current page
Access: public

[ Top ]

getLogMessages [line 987]

string getLogMessages(
)

Return the contents of the log.

This is a placeholder intended to make the code generator make this API available to clients. The selenium server will intercept this call, however, and return its recordkeeping of log messages since the last call to this API. Thus this code in JavaScript will never be called.

The reason I opted for a servercentric solution is to be able to support multiple frames served from different domains, which would break a centralized JavaScript logging mechanism under some conditions.

Return: all log messages seen since the last call to this API
Access: public

[ Top ]

getMouseSpeed [line 1681]

number getMouseSpeed(
)

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

Return: the number of pixels between "mousemove" events during dragAndDrop commands (default=10)
Access: public

[ Top ]

getPrompt [line 1244]

string getPrompt(
)

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.

Return: the message of the most recent JavaScript question prompt
Access: public

[ Top ]

getSelectedId [line 1479]

string getSelectedId(
string
$selectLocator)

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

Return: the selected option ID in the specified select drop-down
Access: public

Parameters:

string $selectLocator — an element locator identifying a drop-down menu

[ Top ]

getSelectedIds [line 1466]

array getSelectedIds(
string
$selectLocator)

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

Return: an array of all selected option IDs in the specified select drop-down
Access: public

Parameters:

string $selectLocator — an element locator identifying a drop-down menu

[ Top ]

getSelectedIndex [line 1453]

string getSelectedIndex(
string
$selectLocator)

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

Return: the selected option index in the specified select drop-down
Access: public

Parameters:

string $selectLocator — an element locator identifying a drop-down menu

[ Top ]

getSelectedIndexes [line 1440]

array getSelectedIndexes(
string
$selectLocator)

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

Return: an array of all selected option indexes in the specified select drop-down
Access: public

Parameters:

string $selectLocator — an element locator identifying a drop-down menu

[ Top ]

getSelectedLabel [line 1401]

string getSelectedLabel(
string
$selectLocator)

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

Return: the selected option label in the specified select drop-down
Access: public

Parameters:

string $selectLocator — an element locator identifying a drop-down menu

[ Top ]

getSelectedLabels [line 1388]

array getSelectedLabels(
string
$selectLocator)

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

Return: an array of all selected option labels in the specified select drop-down
Access: public

Parameters:

string $selectLocator — an element locator identifying a drop-down menu

[ Top ]

getSelectedValue [line 1427]

string getSelectedValue(
string
$selectLocator)

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

Return: the selected option value in the specified select drop-down
Access: public

Parameters:

string $selectLocator — an element locator identifying a drop-down menu

[ Top ]

getSelectedValues [line 1414]

array getSelectedValues(
string
$selectLocator)

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

Return: an array of all selected option values in the specified select drop-down
Access: public

Parameters:

string $selectLocator — an element locator identifying a drop-down menu

[ Top ]

getSelectOptions [line 1505]

array getSelectOptions(
string
$selectLocator)

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

Return: an array of all option labels in the specified select drop-down
Access: public

Parameters:

string $selectLocator — an element locator identifying a drop-down menu

[ Top ]

getSpeed [line 712]

void getSpeed(
)

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.

getTable [line 1375]

string getTable(
string
$tableCellAddress)

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

Return: the text from the specified cell
Access: public

Parameters:

string $tableCellAddress — a cell address, e.g. "foo.1.4"

[ Top ]

getText [line 1311]

string getText(
string
$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.

Return: the text of the element
Access: public

Parameters:

string $locator — an element locator

[ Top ]

getTitle [line 1268]

string getTitle(
)

Gets the title of the current page.

Return: the title of the current page
Access: public

[ Top ]

getValue [line 1295]

string getValue(
string
$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.

Return: the element value, or "on/off" for checkbox/radio elements
Access: public

Parameters:

string $locator — an element locator

[ Top ]

getWhetherThisFrameMatchFrameExpression [line 1009]

boolean getWhetherThisFrameMatchFrameExpression(
string
$currentFrameString, string
$target)

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.

Return: true if the new frame is this code's window
Access: public

Parameters:

string	`$currentFrameString`	—	starting frame
string	`$target`	—	new frame (which might be relative to the current one)

[ Top ]

getWhetherThisWindowMatchWindowExpression [line 1031]

boolean getWhetherThisWindowMatchWindowExpression(
string
$currentWindowString, string
$target)

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.

Return: true if the new window is this code's window
Access: public

Parameters:

string	`$currentWindowString`	—	starting window
string	`$target`	—	new window (which might be relative to the current one, e.g., "_parent")

[ Top ]

goBack [line 1082]

void goBack(
)

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

Access: public

[ Top ]

highlight [line 1323]

void highlight(
string
$locator)

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

Access: public

Parameters:

string $locator — an element locator

[ Top ]

isAlertPresent [line 1123]

boolean isAlertPresent(
)

Has an alert occurred?

This function never throws an exception

Return: true if there is an alert
Access: public

[ Top ]

isChecked [line 1361]

boolean isChecked(
string
$locator)

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

Return: true if the checkbox is checked, false otherwise
Access: public

Parameters:

string $locator — an element locator pointing to a checkbox or radio button

[ Top ]

isConfirmationPresent [line 1159]

boolean isConfirmationPresent(
)

Has confirm() been called?

This function never throws an exception

Return: true if there is a pending confirmation
Access: public

[ Top ]

isEditable [line 1575]

boolean isEditable(
string
$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.

Return: true if the input element is editable, false otherwise
Access: public

Parameters:

string $locator — an element locator

[ Top ]

isElementPresent [line 1544]

boolean isElementPresent(
string
$locator)

Verifies that the specified element is somewhere on the page.

Return: true if the element is present, false otherwise
Access: public

Parameters:

string $locator — an element locator

[ Top ]

isOrdered [line 1823]

boolean isOrdered(
string
$locator1, string
$locator2)

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

Return: true if two elements are ordered and have same parent, false otherwise
Access: public

Parameters:

string	`$locator1`	—	an element locator pointing to the first element
string	`$locator2`	—	an element locator pointing to the second element

[ Top ]

isPromptPresent [line 1141]

boolean isPromptPresent(
)

Has a prompt occurred?

This function never throws an exception

Return: true if there is a pending prompt
Access: public

[ Top ]

isSomethingSelected [line 1492]

boolean isSomethingSelected(
string
$selectLocator)

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

Return: true if some option has been selected, false otherwise
Access: public

Parameters:

string $selectLocator — an element locator identifying a drop-down menu

[ Top ]

isTextPresent [line 1531]

boolean isTextPresent(
string
$pattern)

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

Return: true if the pattern matches the text, false otherwise
Access: public

Parameters:

string $pattern — a pattern to match with the text of the page

[ Top ]

isVisible [line 1561]

boolean isVisible(
string
$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.

Return: true if the specified element is visible, false otherwise
Access: public

Parameters:

string $locator — an element locator

[ Top ]

keyDown [line 523]

void keyDown(
string
$locator, string
$keySequence)

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

Access: public

Parameters:

string	`$locator`	—	an element locator
string	`$keySequence`	—	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".

[ Top ]

keyPress [line 422]

void keyPress(
string
$locator, string
$keySequence)

Simulates a user pressing and releasing a key.

Access: public

Parameters:

string	`$locator`	—	an element locator
string	`$keySequence`	—	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".

[ Top ]

keyUp [line 536]

void keyUp(
string
$locator, string
$keySequence)

Simulates a user releasing a key.

Access: public

Parameters:

string	`$locator`	—	an element locator
string	`$keySequence`	—	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".

[ Top ]

metaKeyDown [line 455]

void metaKeyDown(
)

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

Access: public

[ Top ]

metaKeyUp [line 466]

void metaKeyUp(
)

Release the meta key.

Access: public

[ Top ]

mouseDown [line 573]

void mouseDown(
string
$locator)

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

Access: public

Parameters:

string $locator — an element locator

[ Top ]

mouseDownAt [line 587]

void mouseDownAt(
string
$locator, string
$coordString)

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

Access: public

Parameters:

string	`$locator`	—	an element locator
string	`$coordString`	—	specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

[ Top ]

mouseMove [line 627]

void mouseMove(
string
$locator)

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

Access: public

Parameters:

string $locator — an element locator

[ Top ]

mouseMoveAt [line 641]

void mouseMoveAt(
string
$locator, string
$coordString)

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

Access: public

Parameters:

string	`$locator`	—	an element locator
string	`$coordString`	—	specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

[ Top ]

mouseOut [line 560]

void mouseOut(
string
$locator)

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

Access: public

Parameters:

string $locator — an element locator

[ Top ]

mouseOver [line 548]

void mouseOver(
string
$locator)

Simulates a user hovering a mouse over the specified element.

Access: public

Parameters:

string $locator — an element locator

[ Top ]

mouseUp [line 600]

void mouseUp(
string
$locator)

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

Access: public

Parameters:

string $locator — an element locator

[ Top ]

mouseUpAt [line 614]

void mouseUpAt(
string
$locator, string
$coordString)

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

Access: public

Parameters:

string	`$locator`	—	an element locator
string	`$coordString`	—	specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

[ Top ]

open [line 887]

void open(
string
$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.

Access: public

Parameters:

string $url — the URL to open; may be relative or absolute

[ Top ]

openWindow [line 908]

void openWindow(
string
$url, string
$windowID)

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.

<p> 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"). </p>

Access: public

Parameters:

string	`$url`	—	the URL to open, which can be blank
string	`$windowID`	—	the JavaScript window ID of the window to select

[ Top ]

refresh [line 1093]

void refresh(
)

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

Access: public

[ Top ]

removeAllSelections [line 853]

void removeAllSelections(
string
$locator)

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

Access: public

Parameters:

string $locator — an element locator identifying a multi-select box

[ Top ]

removeSelection [line 841]

void removeSelection(
string
$locator, string
$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
Access: public

Parameters:

string	`$locator`	—	an element locator identifying a multi-select box
string	`$optionLocator`	—	an option locator (a label by default)

[ Top ]

select [line 811]

void select(
string
$selectLocator, string
$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.

Access: public

Parameters:

string	`$selectLocator`	—	an element locator identifying a drop-down menu
string	`$optionLocator`	—	an option locator (a label by default)

[ Top ]

selectFrame [line 964]

void selectFrame(
string
$locator)

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 may also use a DOM expression to identify the frame you want directly, like this:

dom=frames["main"].frames["subframe"]

Access: public

Parameters:

string $locator — an element locator identifying a frame or iframe

[ Top ]

selectWindow [line 945]

void selectWindow(
string
$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.

Selenium has several strategies for finding the window object referred to by the "windowID" parameter.

1.) if windowID is 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 objects. Each of these string names matches the second parameter "windowName" past to the JavaScript method window.open(url, windowName, windowFeatures, replaceFlag) (which selenium intercepts).

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").

Access: public

Parameters:

string $windowID — the JavaScript window ID of the window to select

[ Top ]

setContext [line 1916]

void setContext(
string
$context, string
$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.)

Access: public

Parameters:

string	`$context`	—	the message to be sent to the browser
string	`$logLevelThreshold`	—	one of "debug", "info", "warn", "error", sets the threshold for browser-side logging

[ Top ]

setCursorPosition [line 1794]

void setCursorPosition(
string
$locator, string
$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.

Access: public

Parameters:

string	`$locator`	—	an element locator pointing to an input element or textarea
string	`$position`	—	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.

[ Top ]

setMouseSpeed [line 1669]

void setMouseSpeed(
string
$pixels)

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.

Access: public

Parameters:

string $pixels — the number of pixels between "mousemove" events

[ Top ]

setSpeed [line 698]

void setSpeed(
string
$value)

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.

Access: public

Parameters:

string $value — the number of milliseconds to pause after operation

[ Top ]

setTimeout [line 1973]

void setTimeout(
string
$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.

Access: public

Parameters:

string $timeout — a timeout in milliseconds, after which the action will return with an error

[ Top ]

shiftKeyDown [line 433]

void shiftKeyDown(
)

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

Access: public

[ Top ]

shiftKeyUp [line 444]

void shiftKeyUp(
)

Release the shift key.

Access: public

[ Top ]

start [line 325]

void start(
)

Run the browser and set session id.

Access: public

[ Top ]

stop [line 337]

void stop(
)

Close the browser and set session id null

Access: public

[ Top ]

submit [line 866]

void submit(
string
$formLocator)

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

Access: public

Parameters:

string $formLocator — an element locator for the form you want to submit

[ Top ]

type [line 659]

void type(
string
$locator, string
$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.

Access: public

Parameters:

string	`$locator`	—	an element locator
string	`$value`	—	the value to type

[ Top ]

typeKeys [line 685]

void typeKeys(
string
$locator, string
$value)

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.

Access: public

Parameters:

string	`$locator`	—	an element locator
string	`$value`	—	the value to type

[ Top ]

uncheck [line 736]

void uncheck(
string
$locator)

Uncheck a toggle-button (checkbox/radio)

Access: public

Parameters:

string $locator — an element locator

[ Top ]

waitForCondition [line 1956]

void waitForCondition(
string
$script, string
$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.

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

Access: public

Parameters:

string	`$script`	—	the JavaScript snippet to run
string	`$timeout`	—	a timeout in milliseconds, after which this command will return with an error

[ Top ]

waitForPageToLoad [line 1995]

void waitForPageToLoad(
string
$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.

Access: public

Parameters:

string $timeout — a timeout in milliseconds, after which this command will return with an error

[ Top ]

waitForPopUp [line 1044]

void waitForPopUp(
string
$windowID, string
$timeout)

Waits for a popup window to appear and load up.

Access: public

Parameters:

string	`$windowID`	—	the JavaScript window ID of the window that will appear
string	`$timeout`	—	a timeout in milliseconds, after which the action will return with an error

[ Top ]

windowFocus [line 1719]

void windowFocus(
string
$windowName)

Gives focus to a window

Access: public

Parameters:

string $windowName — name of the window to be given focus

[ Top ]

windowMaximize [line 1731]

void windowMaximize(
string
$windowName)

Resize window to take up the entire screen

Access: public

Parameters:

string $windowName — name of the window to be enlarged

[ Top ]

Class: Testing_Selenium

Class Overview

Author(s):

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

__construct (Constructor) [line 310]

Parameters:

addSelection [line 826]

Parameters:

altKeyDown [line 477]

altKeyUp [line 488]

answerOnNextPrompt [line 1071]

Parameters:

check [line 724]

Parameters:

chooseCancelOnNextConfirmation [line 1058]

click [line 351]

Parameters:

clickAt [line 380]

Parameters:

close [line 1105]

controlKeyDown [line 499]

controlKeyUp [line 510]

createCookie [line 2021]

Parameters:

deleteCookie [line 2034]

Parameters:

doubleClick [line 365]

Parameters:

doubleClickAt [line 395]

Parameters:

dragAndDrop [line 1694]

Parameters:

dragAndDropToObject [line 1707]

Parameters:

dragdrop [line 1649]

Parameters:

fireEvent [line 409]

Parameters:

getAlert [line 1184]

getAllButtons [line 1591]

getAllFields [line 1623]

getAllLinks [line 1607]

getAllWindowIds [line 1743]

getAllWindowNames [line 1755]

getAllWindowTitles [line 1767]

getAttribute [line 1518]

Parameters:

getAttributeFromAllWindows [line 1636]

Parameters:

getBodyText [line 1280]

getConfirmation [line 1218]

getCookie [line 2007]

getCursorPosition [line 1894]

Parameters:

getElementHeight [line 1875]

Parameters:

getElementIndex [line 1808]

Parameters:

getElementPositionLeft [line 1836]

Parameters:

getElementPositionTop [line 1849]

Parameters:

getElementWidth [line 1862]

Parameters:

getEval [line 1348]

Parameters:

getExpression [line 1934]

Parameters:

getHtmlSource [line 1780]

getLocation [line 1256]

getLogMessages [line 987]

getMouseSpeed [line 1681]

getPrompt [line 1244]

getSelectedId [line 1479]

Parameters:

getSelectedIds [line 1466]