__construct (Constructor) [line 340]
Testing_Selenium __construct(
string
$browser, string
$browserUrl, [string
$host = 'localhost'], [int
$port = 4444], [int
$timeout = 30000])
|
|
Constructor
Parameters:
addLocationStrategy [line 2390]
void addLocationStrategy(
string
$strategyName, string
$functionDefinition)
|
|
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.
Parameters:
addSelection [line 948]
void addSelection(
string
$locator, string
$optionLocator)
|
|
Add a selection to the set of selected options in a multi-select element using an option locator.
Parameters:
allowNativeXpath [line 2135]
void allowNativeXpath(
string
$allow)
|
|
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.
Parameters:
altKeyDown [line 544]
Press the alt key and hold it down until doAltUp() is called or a new page is loaded.
altKeyUp [line 555]
answerOnNextPrompt [line 1245]
void answerOnNextPrompt(
string
$answer)
|
|
Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()].
Parameters:
assignId [line 2118]
void assignId(
string
$locator, string
$identifier)
|
|
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.
Parameters:
attachFile [line 2454]
void attachFile(
string
$fieldLocator, string
$fileLocator)
|
|
Sets a file input (upload) field to the file listed in fileLocator
Parameters:
captureEntirePageScreenshot [line 2412]
void captureEntirePageScreenshot(
string
$filename, string
$kwargs)
|
|
Saves the entire contents of the current window canvas to a PNG file.
Currently this only works in Mozilla and when running in chrome mode. 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. Implementation mostly borrowed from the Screengrab! Firefox extension. Please see http://www.screengrab.org for details.
Parameters:
captureScreenshot [line 2466]
void captureScreenshot(
string
$filename)
|
|
Captures a PNG screenshot to the specified file.
Parameters:
captureScreenshotToString [line 2478]
string captureScreenshotToString(
)
|
|
Capture a PNG screenshot. It then returns the file as a base 64 encoded string.
check [line 846]
void check(
string
$locator)
|
|
Check a toggle-button (checkbox/radio)
Parameters:
chooseCancelOnNextConfirmation [line 1204]
void chooseCancelOnNextConfirmation(
)
|
|
<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>
chooseOkOnNextConfirmation [line 1232]
void chooseOkOnNextConfirmation(
)
|
|
<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>
click [line 381]
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.
Parameters:
clickAt [line 422]
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.
Parameters:
close [line 1279]
Simulates the user clicking the "close" button in the titlebar of a popup window or tab.
contextMenu [line 407]
void contextMenu(
string
$locator)
|
|
Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
Parameters:
contextMenuAt [line 450]
void contextMenuAt(
string
$locator, string
$coordString)
|
|
Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
Parameters:
controlKeyDown [line 566]
Press the control key and hold it down until doControlUp() is called or a new page is loaded.
controlKeyUp [line 577]
createCookie [line 2288]
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.
Parameters:
deleteAllVisibleCookies [line 2323]
void deleteAllVisibleCookies(
)
|
|
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.
deleteCookie [line 2310]
void deleteCookie(
string
$name, string
$optionsString)
|
|
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.
Parameters:
doCommand [line 2546]
void doCommand(
$verb, [
$args = array()])
|
|
Parameters:
doubleClick [line 395]
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.
Parameters:
doubleClickAt [line 437]
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.
Parameters:
dragAndDrop [line 1873]
void dragAndDrop(
string
$locator, string
$movementsString)
|
|
Drags an element a certain distance and then drops it
Parameters:
dragAndDropToObject [line 1886]
void dragAndDropToObject(
string
$locatorOfObjectToBeDragged, string
$locatorOfDragDestinationObject)
|
|
Drags an element and drops it on another element
Parameters:
dragdrop [line 1828]
void dragdrop(
string
$locator, string
$movementsString)
|
|
deprecated - use dragAndDrop instead
Parameters:
fireEvent [line 464]
void fireEvent(
string
$locator, string
$eventName)
|
|
Explicitly simulate an event, to trigger the corresponding "on
event" handler.
Parameters:
focus [line 476]
void focus(
string
$locator)
|
|
Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field.
Parameters:
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.
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.
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.
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.
getAllWindowIds [line 1920]
Returns the IDs of all windows that the browser knows about.
getAllWindowNames [line 1932]
array getAllWindowNames(
)
|
|
Returns the names of all windows that the browser knows about.
getAllWindowTitles [line 1944]
array getAllWindowTitles(
)
|
|
Returns the titles of all windows that the browser knows about.
getAttribute [line 1697]
string getAttribute(
string
$attributeLocator)
|
|
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).
Parameters:
getAttributeFromAllWindows [line 1815]
array getAttributeFromAllWindows(
string
$attributeName)
|
|
Returns every instance of some attribute from all known windows.
Parameters:
getBodyText [line 1458]
Gets the entire text of the page.
getConfirmation [line 1396]
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 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.
getCookie [line 2248]
Return all cookies of the current page under test.
getCookieByName [line 2261]
string getCookieByName(
string
$name)
|
|
Returns the value of the cookie with the specified name, or throws an error if the cookie is not present.
Parameters:
getCursorPosition [line 2071]
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.
Parameters:
getElementHeight [line 2052]
number getElementHeight(
string
$locator)
|
|
Retrieves the height of an element
Parameters:
getElementIndex [line 1985]
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.
Parameters:
getElementPositionLeft [line 2013]
number getElementPositionLeft(
string
$locator)
|
|
Retrieves the horizontal position of an element
Parameters:
getElementPositionTop [line 2026]
number getElementPositionTop(
string
$locator)
|
|
Retrieves the vertical position of an element
Parameters:
getElementWidth [line 2039]
number getElementWidth(
string
$locator)
|
|
Retrieves the width of an element
Parameters:
getEval [line 1525]
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. Use
window
to refer to the window of your application, e.g.
window.document.getElementById('foo')
If you need to use a locator to refer to a single element in your application page, you can use
this.browserbot.findElement("id=foo")
where "id=foo" is your locator.
Parameters:
getExpression [line 2089]
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.
Parameters:
getHtmlSource [line 1957]
Returns the entire HTML source between the opening and closing "html" tags.
getLocation [line 1434]
Gets the absolute URL of the current page.
getMouseSpeed [line 1860]
Returns the number of pixels between "mousemove" events during dragAndDrop commands (default=10).
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.
getSelectedId [line 1656]
string getSelectedId(
string
$selectLocator)
|
|
Gets option element ID for selected option in the specified select element.
Parameters:
getSelectedIds [line 1643]
array getSelectedIds(
string
$selectLocator)
|
|
Gets all option element IDs for selected options in the specified select or multi-select element.
Parameters:
getSelectedIndex [line 1630]
string getSelectedIndex(
string
$selectLocator)
|
|
Gets option index (option number, starting at 0) for selected option in the specified select element.
Parameters:
getSelectedIndexes [line 1617]
array getSelectedIndexes(
string
$selectLocator)
|
|
Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.
Parameters:
getSelectedLabel [line 1578]
string getSelectedLabel(
string
$selectLocator)
|
|
Gets option label (visible text) for selected option in the specified select element.
Parameters:
getSelectedLabels [line 1565]
array getSelectedLabels(
string
$selectLocator)
|
|
Gets all option labels (visible text) for selected options in the specified select or multi-select element.
Parameters:
getSelectedValue [line 1604]
string getSelectedValue(
string
$selectLocator)
|
|
Gets option value (value attribute) for selected option in the specified select element.
Parameters:
getSelectedValues [line 1591]
array getSelectedValues(
string
$selectLocator)
|
|
Gets all option values (value attributes) for selected options in the specified select or multi-select element.
Parameters:
getSelectOptions [line 1682]
array getSelectOptions(
string
$selectLocator)
|
|
Gets all option labels in the specified select drop-down.
Parameters:
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.
getString [line 2579]
void getString(
$verb, [
$args = array()])
|
|
Parameters:
getTable [line 1552]
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.
Parameters:
getText [line 1489]
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.
Parameters:
getTitle [line 1446]
Gets the title of the current page.
getValue [line 1473]
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.
Parameters:
getWhetherThisFrameMatchFrameExpression [line 1142]
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.
Parameters:
getWhetherThisWindowMatchWindowExpression [line 1164]
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.
Parameters:
getXpathCount [line 2103]
number getXpathCount(
string
$xpath)
|
|
Returns the number of nodes that match the specified xpath, eg. "//table" would give the number of tables.
Parameters:
goBack [line 1256]
Simulates the user clicking the "back" button on their browser.
highlight [line 1501]
void highlight(
string
$locator)
|
|
Briefly changes the backgroundColor of the specified element yellow. Useful for debugging.
Parameters:
ignoreAttributesWithoutValue [line 2155]
void ignoreAttributesWithoutValue(
string
$ignore)
|
|
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").
Parameters:
isAlertPresent [line 1297]
boolean isAlertPresent(
)
|
|
Has an alert occurred?
This function never throws an exception
isChecked [line 1538]
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.
Parameters:
isConfirmationPresent [line 1333]
boolean isConfirmationPresent(
)
|
|
Has confirm() been called?
This function never throws an exception
isCookiePresent [line 2274]
boolean isCookiePresent(
string
$name)
|
|
Returns true if a cookie with the specified name is present, or false otherwise.
Parameters:
isEditable [line 1754]
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.
Parameters:
isElementPresent [line 1723]
boolean isElementPresent(
string
$locator)
|
|
Verifies that the specified element is somewhere on the page.
Parameters:
isOrdered [line 2000]
boolean isOrdered(
string
$locator1, string
$locator2)
|
|
Check if these two elements have same parent and are ordered siblings in the DOM. Two same elements will not be considered ordered.
Parameters:
isPromptPresent [line 1315]
boolean isPromptPresent(
)
|
|
Has a prompt occurred?
This function never throws an exception
isSomethingSelected [line 1669]
boolean isSomethingSelected(
string
$selectLocator)
|
|
Determines whether some option in a drop-down menu is selected.
Parameters:
isTextPresent [line 1710]
boolean isTextPresent(
string
$pattern)
|
|
Verifies that the specified text pattern appears somewhere on the rendered page shown to the user.
Parameters:
isVisible [line 1740]
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.
Parameters:
keyDown [line 590]
void keyDown(
string
$locator, string
$keySequence)
|
|
Simulates a user pressing a key (without releasing it yet).
Parameters:
keyDownNative [line 2508]
void keyDownNative(
string
$keycode)
|
|
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.
Parameters:
keyPress [line 489]
void keyPress(
string
$locator, string
$keySequence)
|
|
Simulates a user pressing and releasing a key.
Parameters:
keyPressNative [line 2540]
void keyPressNative(
string
$keycode)
|
|
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.
Parameters:
keyUp [line 603]
void keyUp(
string
$locator, string
$keySequence)
|
|
Simulates a user releasing a key.
Parameters:
keyUpNative [line 2524]
void keyUpNative(
string
$keycode)
|
|
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.
Parameters:
metaKeyDown [line 522]
Press the meta key and hold it down until doMetaUp() is called or a new page is loaded.
metaKeyUp [line 533]
mouseDown [line 640]
void mouseDown(
string
$locator)
|
|
Simulates a user pressing the left mouse button (without releasing it yet) on the specified element.
Parameters:
mouseDownAt [line 667]
void mouseDownAt(
string
$locator, string
$coordString)
|
|
Simulates a user pressing the left mouse button (without releasing it yet) at the specified location.
Parameters:
mouseDownRight [line 653]
void mouseDownRight(
string
$locator)
|
|
Simulates a user pressing the right mouse button (without releasing it yet) on the specified element.
Parameters:
mouseDownRightAt [line 681]
void mouseDownRightAt(
string
$locator, string
$coordString)
|
|
Simulates a user pressing the right mouse button (without releasing it yet) at the specified location.
Parameters:
mouseMove [line 748]
void mouseMove(
string
$locator)
|
|
Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
Parameters:
mouseMoveAt [line 762]
void mouseMoveAt(
string
$locator, string
$coordString)
|
|
Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
Parameters:
mouseOut [line 627]
void mouseOut(
string
$locator)
|
|
Simulates a user moving the mouse pointer away from the specified element.
Parameters:
mouseOver [line 615]
void mouseOver(
string
$locator)
|
|
Simulates a user hovering a mouse over the specified element.
Parameters:
mouseUp [line 694]
void mouseUp(
string
$locator)
|
|
Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) on the specified element.
Parameters:
mouseUpAt [line 721]
void mouseUpAt(
string
$locator, string
$coordString)
|
|
Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) at the specified location.
Parameters:
mouseUpRight [line 707]
void mouseUpRight(
string
$locator)
|
|
Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) on the specified element.
Parameters:
mouseUpRightAt [line 735]
void mouseUpRightAt(
string
$locator, string
$coordString)
|
|
Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) at the specified location.
Parameters:
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.
Parameters:
openWindow [line 1030]
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>
Parameters:
refresh [line 1267]
Simulates the user clicking the "Refresh" button on their browser.
removeAllSelections [line 975]
void removeAllSelections(
string
$locator)
|
|
Unselects all of the selected options in a multi-select element.
Parameters:
removeSelection [line 963]
void removeSelection(
string
$locator, string
$optionLocator)
|
|
Remove a selection from the set of selected options in a multi-select element using an option locator.
Parameters:
rollup [line 2428]
void rollup(
string
$rollupName, string
$kwargs)
|
|
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.
Parameters:
runScript [line 2356]
void runScript(
string
$script)
|
|
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.
Parameters:
select [line 933]
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.)
- value=valuePattern:
matches options based on their values.
- id=id:
matches options based on their ids.
- index=index:
matches an option based on its index (offset from zero).
If no option locator prefix is provided, the default behaviour is to match on
label.
Parameters:
selectFrame [line 1120]
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 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:
dom=frames["main"].frames["subframe"]
</p>
Parameters:
selectWindow [line 1099]
void selectWindow(
string
$windowID)
|
|
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:
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").
Parameters:
setBrowserLogLevel [line 2338]
void setBrowserLogLevel(
string
$logLevel)
|
|
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.
Parameters:
setContext [line 2441]
void setContext(
string
$context)
|
|
Writes a message to the status bar and adds a note to the browser-side log.
Parameters:
setCursorPosition [line 1971]
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.
Parameters:
setMouseSpeed [line 1848]
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.
Parameters:
setSpeed [line 819]
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.
Parameters:
setTimeout [line 2194]
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.
Parameters:
shiftKeyDown [line 500]
Press the shift key and hold it down until doShiftUp() is called or a new page is loaded.
shiftKeyUp [line 511]
shutDownSeleniumServer [line 2492]
void shutDownSeleniumServer(
)
|
|
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.
start [line 355]
Run the browser and set session id.
stop [line 367]
Close the browser and set session id null
submit [line 988]
void submit(
string
$formLocator)
|
|
Submit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input "Search" forms.
Parameters:
type [line 780]
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.
Parameters:
typeKeys [line 806]
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.
Parameters:
uncheck [line 858]
void uncheck(
string
$locator)
|
|
Uncheck a toggle-button (checkbox/radio)
Parameters:
waitForCondition [line 2177]
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>
Parameters:
waitForFrameToLoad [line 2236]
void waitForFrameToLoad(
string
$frameAddress, string
$timeout)
|
|
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.
Parameters:
waitForPageToLoad [line 2216]
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.
Parameters:
waitForPopUp [line 1177]
void waitForPopUp(
string
$windowID, string
$timeout)
|
|
Waits for a popup window to appear and load up.
Parameters:
windowFocus [line 1897]
Gives focus to the currently selected window
windowMaximize [line 1908]
Resize currently selected window to take up the entire screen
