Class Testing_Selenium

Description

Defines an object that runs Selenium commands.

Element Locators

Element Locators tell Selenium which HTML element a command refers to. The format of a locator is:

locatorType=argument

We support the following strategies for locating elements:

  • identifier=id: Select the element with the specified @id attribute. If no match is found, select the first element whose @name attribute is id. (This is normally the default; see below.)
  • id=id: Select the element with the specified @id attribute.
  • name=name: Select the first element with the specified @name attribute.
    • username
    • name=username
    The name may optionally be followed by one or more element-filters, separated from the name by whitespace. If the filterType is not specified, value is assumed. </p>
    • name=flavour value=chocolate
  • dom=javascriptExpression: Find an element by evaluating the specified string. This allows you to traverse the HTML Document Object Model using JavaScript. Note that you must not return a value in this string; simply make it the last expression in the block.
    • dom=document.forms['myForm'].myDropdown
    • dom=document.images[56]
    • dom=function foo() { return document.links[1]; }; foo();
  • xpath=xpathExpression: Locate an element using an XPath expression.
    • xpath=//img[@alt='The image alt text']
    • xpath=//table[@id='table1']//tr[4]/td[2]
    • xpath=//a[contains(@href,'#id1')]
    • xpath=//a[contains(@href,'#id1')]/@class
    • xpath=(//table[@class='stylee'])//th[text()='theHeaderText']/../td
    • xpath=//input[@name='name2' and @value='yes']
    • xpath=//*[text()="right"]
  • link=textPattern: Select the link (anchor) element which contains text matching the specified pattern.
    • link=The link text
  • css=cssSelectorSyntax: Select the element using css selectors. Please refer to CSS2 selectors, CSS3 selectors for more information. You can also check the TestCssLocators test in the selenium test suite for an example of usage, which is included in the downloaded selenium core package.
    • css=a[href="#id3"]
    • css=span#firstChild + span
    Currently the css selector locator supports all css1, css2 and css3 selectors except namespace in css3, some pseudo classes(:nth-of-type, :nth-last-of-type, :first-of-type, :last-of-type, :only-of-type, :visited, :hover, :active, :focus, :indeterminate) and pseudo elements(::first-line, ::first-letter, ::selection, ::before, ::after). </p>
  • ui=uiSpecifierString: Locate an element by resolving the UI specifier string to another locator, and evaluating it. See the Selenium UI-Element Reference for more details.
    • ui=loginPages::loginButton()
    • ui=settingsPages::toggle(label=Hide Email)
    • ui=forumPages::postBody(index=2)//a[2]
Without an explicit locator prefix, Selenium uses the following default strategies:

  • dom, for locators starting with "document."
  • xpath, for locators starting with "//"
  • identifier, otherwise
Element Filters

Element filters can be used with a locator to refine a list of candidate elements. They are currently used only in the 'name' element-locator.

Filters look much like locators, ie. </p> filterType=argument </p> Supported element-filters are:

value=valuePattern </p> Matches elements based on their values. This is particularly useful for refining a list of similarly-named toggle-buttons. </p> index=index

Selects a single element based on its position in the list (offset from zero). </p> </p> String-match Patterns

Various Pattern syntaxes are available for matching string values:

  • glob:pattern: Match a string against a "glob" (aka "wildmat") pattern. "Glob" is a kind of limited regular-expression syntax typically used in command-line shells. In a glob pattern, "*" represents any sequence of characters, and "?" represents any single character. Glob patterns match against the entire string.
  • regexp:regexp: Match a string using a regular-expression. The full power of JavaScript regular-expressions is available.
  • regexpi:regexpi: Match a string using a case-insensitive regular-expression.
  • exact:string: Match a string exactly, verbatim, without any of that fancy wildcard stuff.
If no pattern prefix is specified, Selenium assumes that it's a "glob" pattern.

For commands that return multiple values (such as verifySelectOptions), the string being matched is a comma-separated list of the return values, where both commas and backslashes in the values are backslash-escaped. When providing a pattern, the optional matching syntax (i.e. glob, regexp, etc.) is specified once, as usual, at the beginning of the pattern.

Located in /Selenium.php (line 291)


	
			
Method Summary
Testing_Selenium __construct (string $browser, string $browserUrl, [string $host = 'localhost'], [int $port = 4444], [int $timeout = 30000])
void addLocationStrategy (string $strategyName, string $functionDefinition)
void addScript (string $scriptContent, string $scriptTagId)
void addSelection (string $locator, string $optionLocator)
void allowNativeXpath (string $allow)
void altKeyDown ()
void altKeyUp ()
void answerOnNextPrompt (string $answer)
void assignId (string $locator, string $identifier)
void attachFile (string $fieldLocator, string $fileLocator)
void captureEntirePageScreenshot (string $filename, string $kwargs)
string captureEntirePageScreenshotToString (string $kwargs)
void captureScreenshot (string $filename)
void check (string $locator)
void click (string $locator)
void clickAt (string $locator, string $coordString)
void close ()
void contextMenu (string $locator)
void contextMenuAt (string $locator, string $coordString)
void controlKeyDown ()
void controlKeyUp ()
void createCookie (string $nameValuePair, string $optionsString)
void deleteCookie (string $name, string $optionsString)
void doCommand ( $verb, [ $args = array()])
void doubleClick (string $locator)
void doubleClickAt (string $locator, string $coordString)
void dragAndDrop (string $locator, string $movementsString)
void dragAndDropToObject (string $locatorOfObjectToBeDragged, string $locatorOfDragDestinationObject)
void dragdrop (string $locator, string $movementsString)
void fireEvent (string $locator, string $eventName)
void focus (string $locator)
string getAlert ()
array getAllButtons ()
array getAllFields ()
array getAllLinks ()
array getAllWindowIds ()
string getAttribute (string $attributeLocator)
array getAttributeFromAllWindows (string $attributeName)
string getBodyText ()
string getConfirmation ()
string getCookie ()
string getCookieByName (string $name)
number getCursorPosition (string $locator)
number getElementHeight (string $locator)
number getElementIndex (string $locator)
number getElementPositionLeft (string $locator)
number getElementPositionTop (string $locator)
number getElementWidth (string $locator)
string getEval (string $script)
string getExpression (string $expression)
string getHtmlSource ()
string getLocation ()
number getMouseSpeed ()
string getPrompt ()
string getSelectedId (string $selectLocator)
array getSelectedIds (string $selectLocator)
string getSelectedIndex (string $selectLocator)
array getSelectedIndexes (string $selectLocator)
string getSelectedLabel (string $selectLocator)
array getSelectedLabels (string $selectLocator)
string getSelectedValue (string $selectLocator)
array getSelectedValues (string $selectLocator)
array getSelectOptions (string $selectLocator)
string getSpeed ()
void getString ( $verb, [ $args = array()])
string getTable (string $tableCellAddress)
string getText (string $locator)
string getTitle ()
string getValue (string $locator)
boolean getWhetherThisFrameMatchFrameExpression (string $currentFrameString, string $target)
boolean getWhetherThisWindowMatchWindowExpression (string $currentWindowString, string $target)
number getXpathCount (string $xpath)
void goBack ()
void highlight (string $locator)
void ignoreAttributesWithoutValue (string $ignore)
boolean isAlertPresent ()
boolean isChecked (string $locator)
boolean isCookiePresent (string $name)
boolean isEditable (string $locator)
boolean isElementPresent (string $locator)
boolean isOrdered (string $locator1, string $locator2)
boolean isPromptPresent ()
boolean isSomethingSelected (string $selectLocator)
boolean isTextPresent (string $pattern)
boolean isVisible (string $locator)
void keyDown (string $locator, string $keySequence)
void keyDownNative (string $keycode)
void keyPress (string $locator, string $keySequence)
void keyPressNative (string $keycode)
void keyUp (string $locator, string $keySequence)
void keyUpNative (string $keycode)
void metaKeyDown ()
void metaKeyUp ()
void mouseDown (string $locator)
void mouseDownAt (string $locator, string $coordString)
void mouseDownRight (string $locator)
void mouseDownRightAt (string $locator, string $coordString)
void mouseMove (string $locator)
void mouseMoveAt (string $locator, string $coordString)
void mouseOut (string $locator)
void mouseOver (string $locator)
void mouseUp (string $locator)
void mouseUpAt (string $locator, string $coordString)
void mouseUpRight (string $locator)
void mouseUpRightAt (string $locator, string $coordString)
void open (string $url)
void openWindow (string $url, string $windowID)
void refresh ()
void removeAllSelections (string $locator)
void removeScript (string $scriptTagId)
void removeSelection (string $locator, string $optionLocator)
void rollup (string $rollupName, string $kwargs)
void runScript (string $script)
void select (string $selectLocator, string $optionLocator)
void selectFrame (string $locator)
void selectWindow (string $windowID)
void setBrowserLogLevel (string $logLevel)
void setContext (string $context)
void setCursorPosition (string $locator, string $position)
void setMouseSpeed (string $pixels)
void setSpeed (string $value)
void setTimeout (string $timeout)
void shiftKeyDown ()
void shiftKeyUp ()
void start ()
void stop ()
void submit (string $formLocator)
void type (string $locator, string $value)
void typeKeys (string $locator, string $value)
void uncheck (string $locator)
void useXpathLibrary (string $libraryName)
void waitForCondition (string $script, string $timeout)
void waitForFrameToLoad (string $frameAddress, string $timeout)
void waitForPageToLoad (string $timeout)
void waitForPopUp (string $windowID, string $timeout)
void windowFocus ()
void windowMaximize ()
Methods
Constructor __construct (line 340)

Constructor

  • throws: Testing_Selenium_Exception
  • access: public
Testing_Selenium __construct (string $browser, string $browserUrl, [string $host = 'localhost'], [int $port = 4444], [int $timeout = 30000])
  • string $browser
  • string $browserUrl
  • string $host
  • int $port
  • int $timeout
addLocationStrategy (line 2390)

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.

  • access: public
void addLocationStrategy (string $strategyName, string $functionDefinition)
  • string $strategyName: the name of the strategy to define; this should use only letters [a-zA-Z] with no spaces or other punctuation.
  • string $functionDefinition: a string defining the body of a function in JavaScript. For example:
    1. return inDocument.getElementById(locator);
addScript (line 2453)

Loads script content into a new script tag in the Selenium document. This

differs from the runScript command in that runScript adds the script tag to the document of the AUT, not the Selenium document. The following entities in the script content are replaced by the characters they represent:

&lt; &gt; &amp;

The corresponding remove command is removeScript.

  • access: public
void addScript (string $scriptContent, string $scriptTagId)
  • string $scriptContent: the Javascript content of the script to add
  • string $scriptTagId: (optional) the id of the new script tag. If specified, and an element with this id already exists, this operation will fail.
addSelection (line 948)

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
void addSelection (string $locator, string $optionLocator)
  • string $locator: an element locator identifying a multi-select box
  • string $optionLocator: an option locator (a label by default)
allowNativeXpath (line 2135)

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.

  • access: public
void allowNativeXpath (string $allow)
  • string $allow: boolean, true means we'll prefer to use native XPath; false means we'll only use JS XPath
altKeyDown (line 544)

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

  • access: public
void altKeyDown ()
altKeyUp (line 555)

Release the alt key.

  • access: public
void altKeyUp ()
answerOnNextPrompt (line 1245)

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

  • access: public
void answerOnNextPrompt (string $answer)
  • string $answer: the answer to give in response to the prompt pop-up
assignId (line 2118)

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.

  • access: public
void assignId (string $locator, string $identifier)
  • string $locator: an element locator pointing to an element
  • string $identifier: a string to be used as the ID of the specified element
attachFile (line 2504)

Sets a file input (upload) field to the file listed in fileLocator

  • access: public
void attachFile (string $fieldLocator, string $fileLocator)
  • string $fieldLocator: an element locator
  • string $fileLocator: a URL pointing to the specified file. Before the file can be set in the input field (fieldLocator), Selenium RC may need to transfer the file to the local machine before attaching the file in a web page form. This is common in selenium grid configurations where the RC server driving the browser is not the same machine that started the test. Supported Browsers: Firefox ("*chrome") only.
captureEntirePageScreenshot (line 2414)

Saves the entire contents of the current window canvas to a PNG file.

Contrast this with the captureScreenshot command, which captures the contents of the OS viewport (i.e. whatever is currently being displayed on the monitor), and is implemented in the RC only. Currently this only works in Firefox when running in chrome mode, and in IE non-HTA using the EXPERIMENTAL "Snapsie" utility. The Firefox implementation is mostly borrowed from the Screengrab! Firefox extension. Please see http://www.screengrab.org and http://snapsie.sourceforge.net/ for details.

  • access: public
void captureEntirePageScreenshot (string $filename, string $kwargs)
  • string $filename: the path to the file to persist the screenshot as. No filename extension will be appended by default. Directories will not be created if they do not exist, and an exception will be thrown, possibly by native code.
  • string $kwargs: a kwargs string that modifies the way the screenshot is captured. Example: "background=#CCFFDD" . Currently valid options: <dl>
captureEntirePageScreenshotToString (line 2545)

Downloads a screenshot of the browser current window canvas to a based 64 encoded PNG file. The entire windows canvas is captured, including parts rendered outside of the current view port.

Currently this only works in Mozilla and when running in chrome mode.

  • return: The base 64 encoded string of the page screenshot (PNG file)
  • access: public
string captureEntirePageScreenshotToString (string $kwargs)
  • string $kwargs: A kwargs string that modifies the way the screenshot is captured. Example: "background=#CCFFDD". This may be useful to set for capturing screenshots of less-than-ideal layouts, for example where absolute positioning causes the calculation of the canvas dimension to fail and a black background is exposed (possibly obscuring black text).
captureScreenshot (line 2516)

Captures a PNG screenshot to the specified file.

  • access: public
void captureScreenshot (string $filename)
  • string $filename: the absolute path to the file to be written, e.g. "c:\blah\screenshot.png"
captureScreenshotToString (line 2528)

Capture a PNG screenshot. It then returns the file as a base 64 encoded string.

  • return: The base 64 encoded string of the screen shot (PNG file)
  • access: public
string captureScreenshotToString ()
check (line 846)

Check a toggle-button (checkbox/radio)

  • access: public
void check (string $locator)
  • string $locator: an element locator
chooseCancelOnNextConfirmation (line 1204)

<p>

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.

</p><p> Take note - every time a confirmation comes up, you must consume it with a corresponding getConfirmation, or else the next selenium operation will fail.

</p>

  • access: public
void chooseCancelOnNextConfirmation ()
chooseOkOnNextConfirmation (line 1232)

<p>

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.

</p><p> Take note - every time a confirmation comes up, you must consume it with a corresponding getConfirmation, or else the next selenium operation will fail.

</p>

  • access: public
void chooseOkOnNextConfirmation ()
click (line 381)

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
void click (string $locator)
  • string $locator: an element locator
clickAt (line 422)

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
void clickAt (string $locator, string $coordString)
  • 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.
close (line 1279)

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

  • access: public
void close ()
contextMenu (line 407)

Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).

  • access: public
void contextMenu (string $locator)
  • string $locator: an element locator
contextMenuAt (line 450)

Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).

  • access: public
void contextMenuAt (string $locator, string $coordString)
  • 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.
controlKeyDown (line 566)

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

  • access: public
void controlKeyDown ()
controlKeyUp (line 577)

Release the control key.

  • access: public
void controlKeyUp ()
createCookie (line 2288)

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
void createCookie (string $nameValuePair, string $optionsString)
  • string $nameValuePair: name and value of the cookie in a format "name=value"
  • string $optionsString: options for the cookie. Currently supported options include 'path', 'max_age' and 'domain'. the optionsString's format is "path=/path/, max_age=60, domain=.foo.com". The order of options are irrelevant, the unit of the value of 'max_age' is second. Note that specifying a domain that isn't a subset of the current domain will usually fail.
deleteAllVisibleCookies (line 2323)

Calls deleteCookie with recurse=true on all cookies visible to the current page.

As noted on the documentation for deleteCookie, recurse=true can be much slower than simply deleting the cookies using a known domain/path.

  • access: public
void deleteAllVisibleCookies ()
deleteCookie (line 2310)

Delete a named cookie with specified path and domain. Be careful; to delete a cookie, you need to delete it using the exact same path and domain that were used to create the cookie.

If the path is wrong, or the domain is wrong, the cookie simply won't be deleted. Also note that specifying a domain that isn't a subset of the current domain will usually fail.

Since there's no way to discover at runtime the original path and domain of a given cookie, we've added an option called 'recurse' to try all sub-domains of the current domain with all paths that are a subset of the current path. Beware; this option can be slow. In big-O notation, it operates in O(n*m) time, where n is the number of dots in the domain name and m is the number of slashes in the path.

  • access: public
void deleteCookie (string $name, string $optionsString)
  • string $name: the name of the cookie to be deleted
  • string $optionsString: options for the cookie. Currently supported options include 'path', 'domain' and 'recurse.' The optionsString's format is "path=/path/, domain=.foo.com, recurse=true". The order of options are irrelevant. Note that specifying a domain that isn't a subset of the current domain will usually fail.
doCommand (line 2627)
  • access: protected
void doCommand ( $verb, [ $args = array()])
  • $verb
  • $args
doubleClick (line 395)

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
void doubleClick (string $locator)
  • string $locator: an element locator
doubleClickAt (line 437)

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
void doubleClickAt (string $locator, string $coordString)
  • 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.
dragAndDrop (line 1873)

Drags an element a certain distance and then drops it

  • access: public
void dragAndDrop (string $locator, string $movementsString)
  • 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"
dragAndDropToObject (line 1886)

Drags an element and drops it on another element

  • access: public
void dragAndDropToObject (string $locatorOfObjectToBeDragged, string $locatorOfDragDestinationObject)
  • 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
dragdrop (line 1828)

deprecated - use dragAndDrop instead

  • access: public
void dragdrop (string $locator, string $movementsString)
  • 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"
fireEvent (line 464)

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

  • access: public
void fireEvent (string $locator, string $eventName)
  • string $locator: an element locator
  • string $eventName: the event name, e.g. "focus" or "blur"
focus (line 476)

Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field.

  • access: public
void focus (string $locator)
  • string $locator: an element locator
getAlert (line 1358)

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 consume it with getAlert, the next Selenium action will fail.

Under Selenium, JavaScript alerts will NOT pop up a visible alert dialog.

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
string getAlert ()
getAllButtons (line 1770)

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
array getAllButtons ()
getAllFields (line 1802)

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
array getAllFields ()
getAllLinks (line 1786)

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
array getAllLinks ()
getAllWindowIds (line 1920)

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

  • return: the IDs of all windows that the browser knows about.
  • access: public
array getAllWindowIds ()
getAllWindowNames (line 1932)

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

  • return: the names of all windows that the browser knows about.
  • access: public
array getAllWindowNames ()
getAllWindowTitles (line 1944)

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

  • return: the titles of all windows that the browser knows about.
  • access: public
array getAllWindowTitles ()
getAttribute (line 1697)

Gets the value of an element attribute. The value of the attribute may differ across browsers (this is the case for the "style" attribute, for example).

  • return: the value of the specified attribute
  • access: public
string getAttribute (string $attributeLocator)
  • string $attributeLocator: an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar"
getAttributeFromAllWindows (line 1815)

Returns every instance of some attribute from all known windows.

  • return: the set of values of this attribute from all known windows.
  • access: public
array getAttributeFromAllWindows (string $attributeName)
  • string $attributeName: name of an attribute on the windows
getBodyText (line 1458)

Gets the entire text of the page.

  • return: the entire text of the page
  • access: public
string getBodyText ()
getConfirmation (line 1396)

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 consume it with getConfirmation, 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
string getConfirmation ()
getCookie (line 2248)

Return all cookies of the current page under test.

  • return: all cookies of the current page under test
  • access: public
string getCookie ()
getCookieByName (line 2261)

Returns the value of the cookie with the specified name, or throws an error if the cookie is not present.

  • return: the value of the cookie
  • access: public
string getCookieByName (string $name)
  • string $name: the name of the cookie
getCursorPosition (line 2071)

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
number getCursorPosition (string $locator)
  • string $locator: an element locator pointing to an input element or textarea
getElementHeight (line 2052)

Retrieves the height of an element

  • return: height of an element in pixels
  • access: public
number getElementHeight (string $locator)
  • string $locator: an element locator pointing to an element
getElementIndex (line 1985)

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
number getElementIndex (string $locator)
  • string $locator: an element locator pointing to an element
getElementPositionLeft (line 2013)

Retrieves the horizontal position of an element

  • return: of pixels from the edge of the frame.
  • access: public
number getElementPositionLeft (string $locator)
  • string $locator: an element locator pointing to an element OR an element itself
getElementPositionTop (line 2026)

Retrieves the vertical position of an element

  • return: of pixels from the edge of the frame.
  • access: public
number getElementPositionTop (string $locator)
  • string $locator: an element locator pointing to an element OR an element itself
getElementWidth (line 2039)

Retrieves the width of an element

  • return: width of an element in pixels
  • access: public
number getElementWidth (string $locator)
  • string $locator: an element locator pointing to an element
getEval (line 1525)

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

  1. this
will refer to the Selenium object. Use
  1. window
to refer to the window of your application, e.g.
  1. window.document.getElementById('foo')

If you need to use a locator to refer to a single element in your application page, you can use

  1. this.browserbot.findElement("id=foo")
where "id=foo" is your locator.

  • return: the results of evaluating the snippet
  • access: public
string getEval (string $script)
  • string $script: the JavaScript snippet to run
getExpression (line 2089)

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
string getExpression (string $expression)
  • string $expression: the value to return
getHtmlSource (line 1957)

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

  • return: the entire HTML source
  • access: public
string getHtmlSource ()
getLocation (line 1434)

Gets the absolute URL of the current page.

  • return: the absolute URL of the current page
  • access: public
string getLocation ()
getMouseSpeed (line 1860)

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
number getMouseSpeed ()
getPrompt (line 1422)

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
string getPrompt ()
getSelectedId (line 1656)

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
string getSelectedId (string $selectLocator)
  • string $selectLocator: an element locator identifying a drop-down menu
getSelectedIds (line 1643)

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
array getSelectedIds (string $selectLocator)
  • string $selectLocator: an element locator identifying a drop-down menu
getSelectedIndex (line 1630)

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
string getSelectedIndex (string $selectLocator)
  • string $selectLocator: an element locator identifying a drop-down menu
getSelectedIndexes (line 1617)

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
array getSelectedIndexes (string $selectLocator)
  • string $selectLocator: an element locator identifying a drop-down menu
getSelectedLabel (line 1578)

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
string getSelectedLabel (string $selectLocator)
  • string $selectLocator: an element locator identifying a drop-down menu
getSelectedLabels (line 1565)

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
array getSelectedLabels (string $selectLocator)
  • string $selectLocator: an element locator identifying a drop-down menu
getSelectedValue (line 1604)

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
string getSelectedValue (string $selectLocator)
  • string $selectLocator: an element locator identifying a drop-down menu
getSelectedValues (line 1591)

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
array getSelectedValues (string $selectLocator)
  • string $selectLocator: an element locator identifying a drop-down menu
getSelectOptions (line 1682)

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
array getSelectOptions (string $selectLocator)
  • string $selectLocator: an element locator identifying a drop-down menu
getSpeed (line 834)

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.

  • return: the execution speed in milliseconds.
  • access: public
string getSpeed ()
getString (line 2660)
  • access: protected
void getString ( $verb, [ $args = array()])
  • $verb
  • $args
getTable (line 1552)

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
string getTable (string $tableCellAddress)
  • string $tableCellAddress: a cell address, e.g. "foo.1.4"
getText (line 1489)

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
string getText (string $locator)
  • string $locator: an element locator
getTitle (line 1446)

Gets the title of the current page.

  • return: the title of the current page
  • access: public
string getTitle ()
getValue (line 1473)

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
string getValue (string $locator)
  • string $locator: an element locator
getWhetherThisFrameMatchFrameExpression (line 1142)

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
boolean getWhetherThisFrameMatchFrameExpression (string $currentFrameString, string $target)
  • string $currentFrameString: starting frame
  • string $target: new frame (which might be relative to the current one)
getWhetherThisWindowMatchWindowExpression (line 1164)

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
boolean getWhetherThisWindowMatchWindowExpression (string $currentWindowString, string $target)
  • string $currentWindowString: starting window
  • string $target: new window (which might be relative to the current one, e.g., "_parent")
getXpathCount (line 2103)

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

  • return: the number of nodes that match the specified xpath
  • access: public
number getXpathCount (string $xpath)
  • string $xpath: the xpath expression to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.
goBack (line 1256)

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

  • access: public
void goBack ()
highlight (line 1501)

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

  • access: public
void highlight (string $locator)
  • string $locator: an element locator
ignoreAttributesWithoutValue (line 2155)

Specifies whether Selenium will ignore xpath attributes that have no value, i.e. are the empty string, when using the non-native xpath evaluation engine. You'd want to do this for performance reasons in IE.

However, this could break certain xpaths, for example an xpath that looks for an attribute whose value is NOT the empty string.

The hope is that such xpaths are relatively rare, but the user should have the option of using them. Note that this only influences xpath evaluation when using the ajaxslt engine (i.e. not "javascript-xpath").

  • access: public
void ignoreAttributesWithoutValue (string $ignore)
  • string $ignore: boolean, true means we'll ignore attributes without value at the expense of xpath "correctness"; false means we'll sacrifice speed for correctness.
isAlertPresent (line 1297)

Has an alert occurred?

This function never throws an exception

  • return: true if there is an alert
  • access: public
boolean isAlertPresent ()
isChecked (line 1538)

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
boolean isChecked (string $locator)
  • string $locator: an element locator pointing to a checkbox or radio button
isConfirmationPresent (line 1333)

Has confirm() been called?

This function never throws an exception

  • return: true if there is a pending confirmation
  • access: public
boolean isConfirmationPresent ()
isCookiePresent (line 2274)

Returns true if a cookie with the specified name is present, or false otherwise.

  • return: true if a cookie with the specified name is present, or false otherwise.
  • access: public
boolean isCookiePresent (string $name)
  • string $name: the name of the cookie
isEditable (line 1754)

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
boolean isEditable (string $locator)
  • string $locator: an element locator
isElementPresent (line 1723)

Verifies that the specified element is somewhere on the page.

  • return: true if the element is present, false otherwise
  • access: public
boolean isElementPresent (string $locator)
  • string $locator: an element locator
isOrdered (line 2000)

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

  • return: true if element1 is the previous sibling of element2, false otherwise
  • access: public
boolean isOrdered (string $locator1, string $locator2)
  • string $locator1: an element locator pointing to the first element
  • string $locator2: an element locator pointing to the second element
isPromptPresent (line 1315)

Has a prompt occurred?

This function never throws an exception

  • return: true if there is a pending prompt
  • access: public
boolean isPromptPresent ()
isSomethingSelected (line 1669)

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

  • return: true if some option has been selected, false otherwise
  • access: public
boolean isSomethingSelected (string $selectLocator)
  • string $selectLocator: an element locator identifying a drop-down menu
isTextPresent (line 1710)

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
boolean isTextPresent (string $pattern)
  • string $pattern: a pattern to match with the text of the page
isVisible (line 1740)

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
boolean isVisible (string $locator)
  • string $locator: an element locator
keyDown (line 590)

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

  • access: public
void keyDown (string $locator, string $keySequence)
  • 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".
keyDownNative (line 2589)

Simulates a user pressing a key (without releasing it yet) by sending a native operating system keystroke.

This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command.

  • access: public
void keyDownNative (string $keycode)
  • string $keycode: an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!
keyPress (line 489)

Simulates a user pressing and releasing a key.

  • access: public
void keyPress (string $locator, string $keySequence)
  • 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".
keyPressNative (line 2621)

Simulates a user pressing and releasing a key by sending a native operating system keystroke.

This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command.

  • access: public
void keyPressNative (string $keycode)
  • string $keycode: an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!
keyUp (line 603)

Simulates a user releasing a key.

  • access: public
void keyUp (string $locator, string $keySequence)
  • 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".
keyUpNative (line 2605)

Simulates a user releasing a key by sending a native operating system keystroke.

This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command.

  • access: public
void keyUpNative (string $keycode)
  • string $keycode: an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!
metaKeyDown (line 522)

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

  • access: public
void metaKeyDown ()
metaKeyUp (line 533)

Release the meta key.

  • access: public
void metaKeyUp ()
mouseDown (line 640)

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

  • access: public
void mouseDown (string $locator)
  • string $locator: an element locator
mouseDownAt (line 667)

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

  • access: public
void mouseDownAt (string $locator, string $coordString)
  • 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.
mouseDownRight (line 653)

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

  • access: public
void mouseDownRight (string $locator)
  • string $locator: an element locator
mouseDownRightAt (line 681)

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

  • access: public
void mouseDownRightAt (string $locator, string $coordString)
  • 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.
mouseMove (line 748)

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

  • access: public
void mouseMove (string $locator)
  • string $locator: an element locator
mouseMoveAt (line 762)

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

  • access: public
void mouseMoveAt (string $locator, string $coordString)
  • 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.
mouseOut (line 627)

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

  • access: public
void mouseOut (string $locator)
  • string $locator: an element locator
mouseOver (line 615)

Simulates a user hovering a mouse over the specified element.

  • access: public
void mouseOver (string $locator)
  • string $locator: an element locator
mouseUp (line 694)

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

  • access: public
void mouseUp (string $locator)
  • string $locator: an element locator
mouseUpAt (line 721)

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

  • access: public
void mouseUpAt (string $locator, string $coordString)
  • 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.
mouseUpRight (line 707)

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

  • access: public
void mouseUpRight (string $locator)
  • string $locator: an element locator
mouseUpRightAt (line 735)

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

  • access: public
void mouseUpRightAt (string $locator, string $coordString)
  • 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.
open (line 1009)

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
void open (string $url)
  • string $url: the URL to open; may be relative or absolute
openWindow (line 1030)

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
void openWindow (string $url, string $windowID)
  • string $url: the URL to open, which can be blank
  • string $windowID: the JavaScript window ID of the window to select
refresh (line 1267)

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

  • access: public
void refresh ()
removeAllSelections (line 975)

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

  • access: public
void removeAllSelections (string $locator)
  • string $locator: an element locator identifying a multi-select box
removeScript (line 2466)

Removes a script tag from the Selenium document identified by the given id. Does nothing if the referenced tag doesn't exist.

  • access: public
void removeScript (string $scriptTagId)
  • string $scriptTagId: the id of the script element to remove.
removeSelection (line 963)

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
void removeSelection (string $locator, string $optionLocator)
  • string $locator: an element locator identifying a multi-select box
  • string $optionLocator: an option locator (a label by default)
retrieveLastRemoteControlLogs (line 2573)

Retrieve the last messages logged on a specific remote control. Useful for error reports, especially when running multiple remote controls in a distributed environment. The maximum number of log messages that can be retrieve is configured on remote control startup.

  • return: The last N log messages as a multi-line string.
  • access: public
string retrieveLastRemoteControlLogs ()
rollup (line 2430)

Executes a command rollup, which is a series of commands with a unique name, and optionally arguments that control the generation of the set of commands. If any one of the rolled-up commands fails, the rollup is considered to have failed. Rollups may also contain nested rollups.

  • access: public
void rollup (string $rollupName, string $kwargs)
  • string $rollupName: the name of the rollup command
  • string $kwargs: keyword arguments string that influences how the rollup expands into commands
runScript (line 2356)

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.

  • access: public
void runScript (string $script)
  • string $script: the JavaScript snippet to run
select (line 933)

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
void select (string $selectLocator, string $optionLocator)
  • string $selectLocator: an element locator identifying a drop-down menu
  • string $optionLocator: an option locator (a label by default)
selectFrame (line 1120)

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

<p> You may also use a DOM expression to identify the frame you want directly, like this:

  1. dom=frames["main"].frames["subframe"]
</p>

  • access: public
void selectFrame (string $locator)
  • string $locator: an element locator identifying a frame or iframe
selectWindow (line 1099)

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

Window locators provide different ways of specifying the window object: by title, by internal JavaScript "name," or by JavaScript variable.

  • title=My Special Window: Finds the window using the text that appears in the title bar. Be careful; two windows can share the same title. If that happens, this locator will just pick one.
  • name=myWindow: Finds the window using its internal JavaScript "name" property. This is the second parameter "windowName" passed to the JavaScript method window.open(url, windowName, windowFeatures, replaceFlag) (which Selenium intercepts).
  • var=variableName: Some pop-up windows are unnamed (anonymous), but are associated with a JavaScript variable name in the current application window, e.g. "window.foo = window.open(url);". In those cases, you can open the window using "var=foo".
If no window locator prefix is provided, we'll try to guess what you mean like this:

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

  1. debugwindow.open call interceptedwindow 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
void selectWindow (string $windowID)
  • string $windowID: the JavaScript window ID of the window to select
setBrowserLogLevel (line 2338)

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.

  • access: public
void setBrowserLogLevel (string $logLevel)
  • string $logLevel: one of the following: "debug", "info", "warn", "error" or "off"
setContext (line 2491)

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

  • access: public
void setContext (string $context)
  • string $context: the message to be sent to the browser
setCursorPosition (line 1971)

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
void setCursorPosition (string $locator, string $position)
  • 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.
setMouseSpeed (line 1848)

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
void setMouseSpeed (string $pixels)
  • string $pixels: the number of pixels between "mousemove" events
setSpeed (line 819)

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
void setSpeed (string $value)
  • string $value: the number of milliseconds to pause after operation
setTimeout (line 2194)

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
void setTimeout (string $timeout)
  • string $timeout: a timeout in milliseconds, after which the action will return with an error
shiftKeyDown (line 500)

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

  • access: public
void shiftKeyDown ()
shiftKeyUp (line 511)

Release the shift key.

  • access: public
void shiftKeyUp ()
shutDownSeleniumServer (line 2559)

Kills the running Selenium Server and all browser sessions. After you run this command, you will no longer be able to send commands to the server; you can't remotely start the server once it has been stopped. Normally you should prefer to run the "stop" command, which terminates the current browser session, rather than shutting down the entire server.

  • access: public
void shutDownSeleniumServer ()
start (line 355)

Run the browser and set session id.

  • access: public
void start ()
stop (line 367)

Close the browser and set session id null

  • access: public
void stop ()
submit (line 988)

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

  • access: public
void submit (string $formLocator)
  • string $formLocator: an element locator for the form you want to submit
type (line 780)

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
void type (string $locator, string $value)
  • string $locator: an element locator
  • string $value: the value to type
typeKeys (line 806)

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
void typeKeys (string $locator, string $value)
  • string $locator: an element locator
  • string $value: the value to type
uncheck (line 858)

Uncheck a toggle-button (checkbox/radio)

  • access: public
void uncheck (string $locator)
  • string $locator: an element locator
useXpathLibrary (line 2478)

Allows choice of one of the available libraries.

  • access: public
void useXpathLibrary (string $libraryName)
  • string $libraryName: name of the desired library Only the following three can be chosen: ajaxslt - Google's library javascript - Cybozu Labs' faster library default - The default library. Currently the default library is ajaxslt. If libraryName isn't one of these three, then no change will be made.
waitForCondition (line 2177)

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

  1. selenium.browserbot.getCurrentWindow()
, and then run your JavaScript in there </p>

  • access: public
void waitForCondition (string $script, string $timeout)
  • string $script: the JavaScript snippet to run
  • string $timeout: a timeout in milliseconds, after which this command will return with an error
waitForFrameToLoad (line 2236)

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.

  • access: public
void waitForFrameToLoad (string $frameAddress, string $timeout)
  • string $frameAddress: FrameAddress from the server side
  • string $timeout: a timeout in milliseconds, after which this command will return with an error
waitForPageToLoad (line 2216)

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
void waitForPageToLoad (string $timeout)
  • string $timeout: a timeout in milliseconds, after which this command will return with an error
waitForPopUp (line 1177)

Waits for a popup window to appear and load up.

  • access: public
void waitForPopUp (string $windowID, string $timeout)
  • string $windowID: the JavaScript window "name" of the window that will appear (not the text of the title bar)
  • string $timeout: a timeout in milliseconds, after which the action will return with an error
windowFocus (line 1897)

Gives focus to the currently selected window

  • access: public
void windowFocus ()
windowMaximize (line 1908)

Resize currently selected window to take up the entire screen

  • access: public
void windowMaximize ()

Documentation generated on Mon, 12 Jan 2009 15:23:31 -0600 by phpDocumentor 1.4.2