|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Selenium
Defines an object that runs Selenium commands.
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:
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.
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).
Without an explicit locator prefix, Selenium uses the following default strategies:
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.
filterType=argumentSupported element-filters are:
value=valuePattern
Matches elements based on their values. This is particularly useful for refining a list of similarly-named toggle-buttons.index=index
Selects a single element based on its position in the list (offset from zero).
Various Pattern syntaxes are available for matching string values:
If no pattern prefix is specified, Selenium assumes that it's a "glob" pattern.
Method Summary | |
---|---|
void |
addLocationStrategy(java.lang.String strategyName,
java.lang.String functionDefinition)
Defines a new function for Selenium to locate elements on the page. |
void |
addSelection(java.lang.String locator,
java.lang.String optionLocator)
Add a selection to the set of selected options in a multi-select element using an option locator. |
void |
allowNativeXpath(java.lang.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. |
void |
altKeyDown()
Press the alt key and hold it down until doAltUp() is called or a new page is loaded. |
void |
altKeyUp()
Release the alt key. |
void |
answerOnNextPrompt(java.lang.String answer)
Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()]. |
void |
assignId(java.lang.String locator,
java.lang.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. |
void |
captureScreenshot(java.lang.String filename)
Captures a PNG screenshot to the specified file. |
void |
check(java.lang.String locator)
Check a toggle-button (checkbox/radio) |
void |
chooseCancelOnNextConfirmation()
By default, Selenium's overridden window.confirm() function will return true, as if the user had manually clicked OK; after running this command, the next call to confirm() will return false, as if the user had clicked Cancel. |
void |
chooseOkOnNextConfirmation()
Undo the effect of calling chooseCancelOnNextConfirmation. |
void |
click(java.lang.String locator)
Clicks on a link, button, checkbox or radio button. |
void |
clickAt(java.lang.String locator,
java.lang.String coordString)
Clicks on a link, button, checkbox or radio button. |
void |
close()
Simulates the user clicking the "close" button in the titlebar of a popup window or tab. |
void |
controlKeyDown()
Press the control key and hold it down until doControlUp() is called or a new page is loaded. |
void |
controlKeyUp()
Release the control key. |
void |
createCookie(java.lang.String nameValuePair,
java.lang.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. |
void |
deleteCookie(java.lang.String name,
java.lang.String path)
Delete a named cookie with specified path. |
void |
doubleClick(java.lang.String locator)
Double clicks on a link, button, checkbox or radio button. |
void |
doubleClickAt(java.lang.String locator,
java.lang.String coordString)
Doubleclicks on a link, button, checkbox or radio button. |
void |
dragAndDrop(java.lang.String locator,
java.lang.String movementsString)
Drags an element a certain distance and then drops it |
void |
dragAndDropToObject(java.lang.String locatorOfObjectToBeDragged,
java.lang.String locatorOfDragDestinationObject)
Drags an element and drops it on another element |
void |
dragdrop(java.lang.String locator,
java.lang.String movementsString)
deprecated - use dragAndDrop instead |
void |
fireEvent(java.lang.String locator,
java.lang.String eventName)
Explicitly simulate an event, to trigger the corresponding "onevent" handler. |
java.lang.String |
getAlert()
Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts. |
java.lang.String[] |
getAllButtons()
Returns the IDs of all buttons on the page. |
java.lang.String[] |
getAllFields()
Returns the IDs of all input fields on the page. |
java.lang.String[] |
getAllLinks()
Returns the IDs of all links on the page. |
java.lang.String[] |
getAllWindowIds()
Returns the IDs of all windows that the browser knows about. |
java.lang.String[] |
getAllWindowNames()
Returns the names of all windows that the browser knows about. |
java.lang.String[] |
getAllWindowTitles()
Returns the titles of all windows that the browser knows about. |
java.lang.String |
getAttribute(java.lang.String attributeLocator)
Gets the value of an element attribute. |
java.lang.String[] |
getAttributeFromAllWindows(java.lang.String attributeName)
Returns every instance of some attribute from all known windows. |
java.lang.String |
getBodyText()
Gets the entire text of the page. |
java.lang.String |
getConfirmation()
Retrieves the message of a JavaScript confirmation dialog generated during the previous action. |
java.lang.String |
getCookie()
Return all cookies of the current page under test. |
java.lang.Number |
getCursorPosition(java.lang.String locator)
Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers. |
java.lang.Number |
getElementHeight(java.lang.String locator)
Retrieves the height of an element |
java.lang.Number |
getElementIndex(java.lang.String locator)
Get the relative index of an element to its parent (starting from 0). |
java.lang.Number |
getElementPositionLeft(java.lang.String locator)
Retrieves the horizontal position of an element |
java.lang.Number |
getElementPositionTop(java.lang.String locator)
Retrieves the vertical position of an element |
java.lang.Number |
getElementWidth(java.lang.String locator)
Retrieves the width of an element |
java.lang.String |
getEval(java.lang.String script)
Gets the result of evaluating the specified JavaScript snippet. |
java.lang.String |
getExpression(java.lang.String expression)
Returns the specified expression. |
java.lang.String |
getHtmlSource()
Returns the entire HTML source between the opening and closing "html" tags. |
java.lang.String |
getLocation()
Gets the absolute URL of the current page. |
java.lang.Number |
getMouseSpeed()
Returns the number of pixels between "mousemove" events during dragAndDrop commands (default=10). |
java.lang.String |
getPrompt()
Retrieves the message of a JavaScript question prompt dialog generated during the previous action. |
java.lang.String |
getSelectedId(java.lang.String selectLocator)
Gets option element ID for selected option in the specified select element. |
java.lang.String[] |
getSelectedIds(java.lang.String selectLocator)
Gets all option element IDs for selected options in the specified select or multi-select element. |
java.lang.String |
getSelectedIndex(java.lang.String selectLocator)
Gets option index (option number, starting at 0) for selected option in the specified select element. |
java.lang.String[] |
getSelectedIndexes(java.lang.String selectLocator)
Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element. |
java.lang.String |
getSelectedLabel(java.lang.String selectLocator)
Gets option label (visible text) for selected option in the specified select element. |
java.lang.String[] |
getSelectedLabels(java.lang.String selectLocator)
Gets all option labels (visible text) for selected options in the specified select or multi-select element. |
java.lang.String |
getSelectedValue(java.lang.String selectLocator)
Gets option value (value attribute) for selected option in the specified select element. |
java.lang.String[] |
getSelectedValues(java.lang.String selectLocator)
Gets all option values (value attributes) for selected options in the specified select or multi-select element. |
java.lang.String[] |
getSelectOptions(java.lang.String selectLocator)
Gets all option labels in the specified select drop-down. |
void |
getSpeed()
Get execution speed (i.e., get the millisecond length of the delay following each selenium operation). |
java.lang.String |
getTable(java.lang.String tableCellAddress)
Gets the text from a cell of a table. |
java.lang.String |
getText(java.lang.String locator)
Gets the text of an element. |
java.lang.String |
getTitle()
Gets the title of the current page. |
java.lang.String |
getValue(java.lang.String locator)
Gets the (whitespace-trimmed) value of an input field (or anything else with a value parameter). |
boolean |
getWhetherThisFrameMatchFrameExpression(java.lang.String currentFrameString,
java.lang.String target)
Determine whether current/locator identify the frame containing this running code. |
boolean |
getWhetherThisWindowMatchWindowExpression(java.lang.String currentWindowString,
java.lang.String target)
Determine whether currentWindowString plus target identify the window containing this running code. |
java.lang.Number |
getXpathCount(java.lang.String xpath)
Returns the number of nodes that match the specified xpath, eg. |
void |
goBack()
Simulates the user clicking the "back" button on their browser. |
void |
highlight(java.lang.String locator)
Briefly changes the backgroundColor of the specified element yellow. |
boolean |
isAlertPresent()
Has an alert occurred? |
boolean |
isChecked(java.lang.String locator)
Gets whether a toggle-button (checkbox/radio) is checked. |
boolean |
isConfirmationPresent()
Has confirm() been called? |
boolean |
isEditable(java.lang.String locator)
Determines whether the specified input element is editable, ie hasn't been disabled. |
boolean |
isElementPresent(java.lang.String locator)
Verifies that the specified element is somewhere on the page. |
boolean |
isOrdered(java.lang.String locator1,
java.lang.String locator2)
Check if these two elements have same parent and are ordered siblings in the DOM. |
boolean |
isPromptPresent()
Has a prompt occurred? |
boolean |
isSomethingSelected(java.lang.String selectLocator)
Determines whether some option in a drop-down menu is selected. |
boolean |
isTextPresent(java.lang.String pattern)
Verifies that the specified text pattern appears somewhere on the rendered page shown to the user. |
boolean |
isVisible(java.lang.String locator)
Determines if the specified element is visible. |
void |
keyDown(java.lang.String locator,
java.lang.String keySequence)
Simulates a user pressing a key (without releasing it yet). |
void |
keyPress(java.lang.String locator,
java.lang.String keySequence)
Simulates a user pressing and releasing a key. |
void |
keyUp(java.lang.String locator,
java.lang.String keySequence)
Simulates a user releasing a key. |
void |
metaKeyDown()
Press the meta key and hold it down until doMetaUp() is called or a new page is loaded. |
void |
metaKeyUp()
Release the meta key. |
void |
mouseDown(java.lang.String locator)
Simulates a user pressing the mouse button (without releasing it yet) on the specified element. |
void |
mouseDownAt(java.lang.String locator,
java.lang.String coordString)
Simulates a user pressing the mouse button (without releasing it yet) at the specified location. |
void |
mouseMove(java.lang.String locator)
Simulates a user pressing the mouse button (without releasing it yet) on the specified element. |
void |
mouseMoveAt(java.lang.String locator,
java.lang.String coordString)
Simulates a user pressing the mouse button (without releasing it yet) on the specified element. |
void |
mouseOut(java.lang.String locator)
Simulates a user moving the mouse pointer away from the specified element. |
void |
mouseOver(java.lang.String locator)
Simulates a user hovering a mouse over the specified element. |
void |
mouseUp(java.lang.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. |
void |
mouseUpAt(java.lang.String locator,
java.lang.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. |
void |
open(java.lang.String url)
Opens an URL in the test frame. |
void |
openWindow(java.lang.String url,
java.lang.String windowID)
Opens a popup window (if a window with that ID isn't already open). |
void |
refresh()
Simulates the user clicking the "Refresh" button on their browser. |
void |
removeAllSelections(java.lang.String locator)
Unselects all of the selected options in a multi-select element. |
void |
removeSelection(java.lang.String locator,
java.lang.String optionLocator)
Remove a selection from the set of selected options in a multi-select element using an option locator. |
void |
runScript(java.lang.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. |
void |
select(java.lang.String selectLocator,
java.lang.String optionLocator)
Select an option from a drop-down using an option locator. |
void |
selectFrame(java.lang.String locator)
Selects a frame within the current window. |
void |
selectWindow(java.lang.String windowID)
Selects a popup window; once a popup window has been selected, all commands go to that window. |
void |
setBrowserLogLevel(java.lang.String logLevel)
Sets the threshold for browser-side logging messages; log messages beneath this threshold will be discarded. |
void |
setContext(java.lang.String context)
Writes a message to the status bar and adds a note to the browser-side log. |
void |
setCursorPosition(java.lang.String locator,
java.lang.String position)
Moves the text cursor to the specified position in the given input element or textarea. |
void |
setMouseSpeed(java.lang.String pixels)
Configure the number of pixels between "mousemove" events during dragAndDrop commands (default=10). |
void |
setSpeed(java.lang.String value)
Set execution speed (i.e., set the millisecond length of a delay which will follow each selenium operation). |
void |
setTimeout(java.lang.String timeout)
Specifies the amount of time that Selenium will wait for actions to complete. |
void |
shiftKeyDown()
Press the shift key and hold it down until doShiftUp() is called or a new page is loaded. |
void |
shiftKeyUp()
Release the shift key. |
void |
start()
Launches the browser with a new Selenium session |
void |
stop()
Ends the test session, killing the browser |
void |
submit(java.lang.String formLocator)
Submit the specified form. |
void |
type(java.lang.String locator,
java.lang.String value)
Sets the value of an input field, as though you typed it in. |
void |
typeKeys(java.lang.String locator,
java.lang.String value)
Simulates keystroke events on the specified element, as though you typed the value key-by-key. |
void |
uncheck(java.lang.String locator)
Uncheck a toggle-button (checkbox/radio) |
void |
waitForCondition(java.lang.String script,
java.lang.String timeout)
Runs the specified JavaScript snippet repeatedly until it evaluates to "true". |
void |
waitForFrameToLoad(java.lang.String frameAddress,
java.lang.String timeout)
Waits for a new frame to load. |
void |
waitForPageToLoad(java.lang.String timeout)
Waits for a new page to load. |
void |
waitForPopUp(java.lang.String windowID,
java.lang.String timeout)
Waits for a popup window to appear and load up. |
void |
windowFocus()
Gives focus to the currently selected window |
void |
windowMaximize()
Resize currently selected window to take up the entire screen |
Method Detail |
---|
void start()
void stop()
void click(java.lang.String locator)
locator
- an element locatorvoid doubleClick(java.lang.String locator)
locator
- an element locatorvoid clickAt(java.lang.String locator, java.lang.String coordString)
locator
- an element locatorcoordString
- specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.void doubleClickAt(java.lang.String locator, java.lang.String coordString)
locator
- an element locatorcoordString
- specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.void fireEvent(java.lang.String locator, java.lang.String eventName)
locator
- an element locatoreventName
- the event name, e.g. "focus" or "blur"void keyPress(java.lang.String locator, java.lang.String keySequence)
locator
- an element locatorkeySequence
- 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".void shiftKeyDown()
void shiftKeyUp()
void metaKeyDown()
void metaKeyUp()
void altKeyDown()
void altKeyUp()
void controlKeyDown()
void controlKeyUp()
void keyDown(java.lang.String locator, java.lang.String keySequence)
locator
- an element locatorkeySequence
- 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".void keyUp(java.lang.String locator, java.lang.String keySequence)
locator
- an element locatorkeySequence
- 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".void mouseOver(java.lang.String locator)
locator
- an element locatorvoid mouseOut(java.lang.String locator)
locator
- an element locatorvoid mouseDown(java.lang.String locator)
locator
- an element locatorvoid mouseDownAt(java.lang.String locator, java.lang.String coordString)
locator
- an element locatorcoordString
- specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.void mouseUp(java.lang.String locator)
locator
- an element locatorvoid mouseUpAt(java.lang.String locator, java.lang.String coordString)
locator
- an element locatorcoordString
- specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.void mouseMove(java.lang.String locator)
locator
- an element locatorvoid mouseMoveAt(java.lang.String locator, java.lang.String coordString)
locator
- an element locatorcoordString
- specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.void type(java.lang.String locator, java.lang.String value)
Can also be used to set the value of combo boxes, check boxes, etc. In these cases, value should be the value of the option selected, not the visible text.
locator
- an element locatorvalue
- the value to typevoid typeKeys(java.lang.String locator, java.lang.String value)
This is a convenience method for calling keyDown, keyUp, keyPress for every character in the specified string; this is useful for dynamic UI widgets (like auto-completing combo boxes) that require explicit key events.
Unlike the simple "type" command, which forces the specified value into the page directly, this command may or may not have any visible effect, even in cases where typing keys would normally have a visible effect. For example, if you use "typeKeys" on a form element, you may or may not see the results of what you typed in the field.
In some cases, you may need to use the simple "type" command to set the value of the field and then the "typeKeys" command to send the keystroke events corresponding to what you just typed.
locator
- an element locatorvalue
- the value to typevoid setSpeed(java.lang.String value)
value
- the number of milliseconds to pause after operationvoid getSpeed()
void check(java.lang.String locator)
locator
- an element locatorvoid uncheck(java.lang.String locator)
locator
- an element locatorvoid select(java.lang.String selectLocator, java.lang.String optionLocator)
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.
If no option locator prefix is provided, the default behaviour is to match on label.
selectLocator
- an element locator identifying a drop-down menuoptionLocator
- an option locator (a label by default)void addSelection(java.lang.String locator, java.lang.String optionLocator)
locator
- an element locator identifying a multi-select boxoptionLocator
- an option locator (a label by default)for details of option locators
void removeSelection(java.lang.String locator, java.lang.String optionLocator)
locator
- an element locator identifying a multi-select boxoptionLocator
- an option locator (a label by default)for details of option locators
void removeAllSelections(java.lang.String locator)
locator
- an element locator identifying a multi-select boxvoid submit(java.lang.String formLocator)
formLocator
- an element locator for the form you want to submitvoid open(java.lang.String url)
url
- the URL to open; may be relative or absolutevoid openWindow(java.lang.String url, java.lang.String windowID)
This command can also be a useful workaround for bug SEL-339. In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example). In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using an empty (blank) url, like this: openWindow("", "myFunnyWindow").
url
- the URL to open, which can be blankwindowID
- the JavaScript window ID of the window to selectvoid selectWindow(java.lang.String windowID)
Note that there is a big difference between a window's internal JavaScript "name" property and the "title" of a given window's document (which is normally what you actually see, as an end user, in the title bar of the window). The "name" is normally invisible to the end-user; it's the second parameter "windowName" passed to the JavaScript method window.open(url, windowName, windowFeatures, replaceFlag) (which selenium intercepts).
Selenium has several strategies for finding the window object referred to by the "windowID" parameter.
1.) if windowID is null, (or the string "null") then it is assumed the user is referring to the original window instantiated by the browser).
2.) if the value of the "windowID" parameter is a JavaScript variable name in the current application window, then it is assumed that this variable contains the return value from a call to the JavaScript window.open() method.
3.) Otherwise, selenium looks in a hash it maintains that maps string names to window "names".
4.) If that fails, we'll try looping over all of the known windows to try to find the appropriate "title". Since "title" is not necessarily unique, this may have unexpected behavior.
If you're having trouble figuring out what is the name of a window that you want to manipulate, look at the selenium log messages which identify the names of windows created via window.open (and therefore intercepted by selenium). You will see messages like the following for each window as it is opened:
debug: window.open call intercepted; window ID (which you can use with selectWindow()) is "myNewWindow"
In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example). (This is bug SEL-339.) In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using an empty (blank) url, like this: openWindow("", "myFunnyWindow").
windowID
- the JavaScript window ID of the window to selectvoid selectFrame(java.lang.String locator)
You may also use a DOM expression to identify the frame you want directly,
like this: dom=frames["main"].frames["subframe"]
locator
- an element locator identifying a frame or iframeboolean getWhetherThisFrameMatchFrameExpression(java.lang.String currentFrameString, java.lang.String target)
This is useful in proxy injection mode, where this code runs in every browser frame and window, and sometimes the selenium server needs to identify the "current" frame. In this case, when the test calls selectFrame, this routine is called for each frame to figure out which one has been selected. The selected frame will return true, while all others will return false.
currentFrameString
- starting frametarget
- new frame (which might be relative to the current one)
boolean getWhetherThisWindowMatchWindowExpression(java.lang.String currentWindowString, java.lang.String target)
This is useful in proxy injection mode, where this code runs in every browser frame and window, and sometimes the selenium server needs to identify the "current" window. In this case, when the test calls selectWindow, this routine is called for each window to figure out which one has been selected. The selected window will return true, while all others will return false.
currentWindowString
- starting windowtarget
- new window (which might be relative to the current one, e.g., "_parent")
void waitForPopUp(java.lang.String windowID, java.lang.String timeout)
windowID
- the JavaScript window ID of the window that will appeartimeout
- a timeout in milliseconds, after which the action will return with an errorvoid chooseCancelOnNextConfirmation()
void chooseOkOnNextConfirmation()
void answerOnNextPrompt(java.lang.String answer)
answer
- the answer to give in response to the prompt pop-upvoid goBack()
void refresh()
void close()
boolean isAlertPresent()
This function never throws an exception
boolean isPromptPresent()
This function never throws an exception
boolean isConfirmationPresent()
This function never throws an exception
java.lang.String getAlert()
Getting an alert has the same effect as manually clicking OK. If an alert is generated but you do not get/verify it, the next Selenium action will fail.
NOTE: under Selenium, JavaScript alerts will NOT pop up a visible alert dialog.
NOTE: Selenium does NOT support JavaScript alerts that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until someone manually clicks OK.
java.lang.String getConfirmation()
By default, the confirm function will return true, having the same effect as manually clicking OK. This can be changed by prior execution of the chooseCancelOnNextConfirmation command. If an confirmation is generated but you do not get/verify it, the next Selenium action will fail.
NOTE: under Selenium, JavaScript confirmations will NOT pop up a visible dialog.
NOTE: Selenium does NOT support JavaScript confirmations that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until you manually click OK.
java.lang.String getPrompt()
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.
java.lang.String getLocation()
java.lang.String getTitle()
java.lang.String getBodyText()
java.lang.String getValue(java.lang.String locator)
locator
- an element locator
java.lang.String getText(java.lang.String locator)
locator
- an element locator
void highlight(java.lang.String locator)
locator
- an element locatorjava.lang.String getEval(java.lang.String script)
Note that, by default, the snippet will run in the context of the "selenium"
object itself, so this
will refer to the Selenium object. Use window
to
refer to the window of your application, e.g. window.document.getElementById('foo')
If you need to use
a locator to refer to a single element in your application page, you can
use this.browserbot.findElement("id=foo")
where "id=foo" is your locator.
script
- the JavaScript snippet to run
boolean isChecked(java.lang.String locator)
locator
- an element locator pointing to a checkbox or radio button
java.lang.String getTable(java.lang.String tableCellAddress)
tableCellAddress
- a cell address, e.g. "foo.1.4"
java.lang.String[] getSelectedLabels(java.lang.String selectLocator)
selectLocator
- an element locator identifying a drop-down menu
java.lang.String getSelectedLabel(java.lang.String selectLocator)
selectLocator
- an element locator identifying a drop-down menu
java.lang.String[] getSelectedValues(java.lang.String selectLocator)
selectLocator
- an element locator identifying a drop-down menu
java.lang.String getSelectedValue(java.lang.String selectLocator)
selectLocator
- an element locator identifying a drop-down menu
java.lang.String[] getSelectedIndexes(java.lang.String selectLocator)
selectLocator
- an element locator identifying a drop-down menu
java.lang.String getSelectedIndex(java.lang.String selectLocator)
selectLocator
- an element locator identifying a drop-down menu
java.lang.String[] getSelectedIds(java.lang.String selectLocator)
selectLocator
- an element locator identifying a drop-down menu
java.lang.String getSelectedId(java.lang.String selectLocator)
selectLocator
- an element locator identifying a drop-down menu
boolean isSomethingSelected(java.lang.String selectLocator)
selectLocator
- an element locator identifying a drop-down menu
java.lang.String[] getSelectOptions(java.lang.String selectLocator)
selectLocator
- an element locator identifying a drop-down menu
java.lang.String getAttribute(java.lang.String attributeLocator)
attributeLocator
- an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar"
boolean isTextPresent(java.lang.String pattern)
pattern
- a pattern to match with the text of the page
boolean isElementPresent(java.lang.String locator)
locator
- an element locator
boolean isVisible(java.lang.String locator)
locator
- an element locator
boolean isEditable(java.lang.String locator)
locator
- an element locator
java.lang.String[] getAllButtons()
If a given button has no ID, it will appear as "" in this array.
java.lang.String[] getAllLinks()
If a given link has no ID, it will appear as "" in this array.
java.lang.String[] getAllFields()
If a given field has no ID, it will appear as "" in this array.
java.lang.String[] getAttributeFromAllWindows(java.lang.String attributeName)
attributeName
- name of an attribute on the windows
void dragdrop(java.lang.String locator, java.lang.String movementsString)
locator
- an element locatormovementsString
- offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"void setMouseSpeed(java.lang.String pixels)
Setting this value to 0 means that we'll send a "mousemove" event to every single pixel in between the start location and the end location; that can be very slow, and may cause some browsers to force the JavaScript to timeout.
If the mouse speed is greater than the distance between the two dragged objects, we'll just send one "mousemove" at the start location and then one final one at the end location.
pixels
- the number of pixels between "mousemove" eventsjava.lang.Number getMouseSpeed()
void dragAndDrop(java.lang.String locator, java.lang.String movementsString)
locator
- an element locatormovementsString
- offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"void dragAndDropToObject(java.lang.String locatorOfObjectToBeDragged, java.lang.String locatorOfDragDestinationObject)
locatorOfObjectToBeDragged
- an element to be draggedlocatorOfDragDestinationObject
- an element whose location (i.e., whose center-most pixel) will be the point where locatorOfObjectToBeDragged is droppedvoid windowFocus()
void windowMaximize()
java.lang.String[] getAllWindowIds()
java.lang.String[] getAllWindowNames()
java.lang.String[] getAllWindowTitles()
java.lang.String getHtmlSource()
void setCursorPosition(java.lang.String locator, java.lang.String position)
locator
- an element locator pointing to an input element or textareaposition
- 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.java.lang.Number getElementIndex(java.lang.String locator)
locator
- an element locator pointing to an element
boolean isOrdered(java.lang.String locator1, java.lang.String locator2)
locator1
- an element locator pointing to the first elementlocator2
- an element locator pointing to the second element
java.lang.Number getElementPositionLeft(java.lang.String locator)
locator
- an element locator pointing to an element OR an element itself
java.lang.Number getElementPositionTop(java.lang.String locator)
locator
- an element locator pointing to an element OR an element itself
java.lang.Number getElementWidth(java.lang.String locator)
locator
- an element locator pointing to an element
java.lang.Number getElementHeight(java.lang.String locator)
locator
- an element locator pointing to an element
java.lang.Number getCursorPosition(java.lang.String locator)
Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to return the position of the last location of the cursor, even though the cursor is now gone from the page. This is filed as SEL-243.
This method will fail if the specified element isn't an input element or textarea, or there is no cursor in the element.
locator
- an element locator pointing to an input element or textarea
java.lang.String getExpression(java.lang.String expression)
This is useful because of JavaScript preprocessing. It is used to generate commands like assertExpression and waitForExpression.
expression
- the value to return
java.lang.Number getXpathCount(java.lang.String xpath)
xpath
- the xpath expression to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.
void assignId(java.lang.String locator, java.lang.String identifier)
locator
- an element locator pointing to an elementidentifier
- a string to be used as the ID of the specified elementvoid allowNativeXpath(java.lang.String allow)
allow
- boolean, true means we'll prefer to use native XPath; false means we'll only use JS XPathvoid waitForCondition(java.lang.String script, java.lang.String timeout)
Note that, by default, the snippet will be run in the runner's test window, not in the window
of your application. To get the window of your application, you can use
the JavaScript snippet selenium.browserbot.getCurrentWindow()
, and then
run your JavaScript in there
script
- the JavaScript snippet to runtimeout
- a timeout in milliseconds, after which this command will return with an errorvoid setTimeout(java.lang.String timeout)
Actions that require waiting include "open" and the "waitFor*" actions.
The default timeout is 30 seconds.
timeout
- a timeout in milliseconds, after which the action will return with an errorvoid waitForPageToLoad(java.lang.String timeout)
You can use this command instead of the "AndWait" suffixes, "clickAndWait", "selectAndWait", "typeAndWait" etc. (which are only available in the JS API).
Selenium constantly keeps track of new pages loading, and sets a "newPageLoaded" flag when it first notices a page load. Running any other Selenium command after turns the flag to false. Hence, if you want to wait for a page to load, you must wait immediately after a Selenium command that caused a page-load.
timeout
- a timeout in milliseconds, after which this command will return with an errorvoid waitForFrameToLoad(java.lang.String frameAddress, java.lang.String timeout)
Selenium constantly keeps track of new pages and frames loading, and sets a "newPageLoaded" flag when it first notices a page load.
See waitForPageToLoad for more information.
frameAddress
- FrameAddress from the server sidetimeout
- a timeout in milliseconds, after which this command will return with an errorjava.lang.String getCookie()
void createCookie(java.lang.String nameValuePair, java.lang.String optionsString)
nameValuePair
- name and value of the cookie in a format "name=value"optionsString
- options for the cookie. Currently supported options include 'path' and 'max_age'. the optionsString's format is "path=/path/, max_age=60". The order of options are irrelevant, the unit of the value of 'max_age' is second.void deleteCookie(java.lang.String name, java.lang.String path)
name
- the name of the cookie to be deletedpath
- the path property of the cookie to be deletedvoid setBrowserLogLevel(java.lang.String logLevel)
logLevel
- one of the following: "debug", "info", "warn", "error" or "off"void runScript(java.lang.String script)
script
- the JavaScript snippet to runvoid addLocationStrategy(java.lang.String strategyName, java.lang.String functionDefinition)
strategyName
- the name of the strategy to define; this should use only letters [a-zA-Z] with no spaces or other punctuation.functionDefinition
- a string defining the body of a function in JavaScript. For example: return inDocument.getElementById(locator);
void setContext(java.lang.String context)
context
- the message to be sent to the browservoid captureScreenshot(java.lang.String filename)
filename
- the absolute path to the file to be written, e.g. "c:\blah\screenshot.png"
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |