biz.neustar.wpm.api
Interface Selenium


public interface Selenium

The Selenium API provided for controlling real browsers. The functions in this object represent all the available Selenium commands. Each command is documented here for your convenience, but it is the same information you'll find in the reference documentation bundled with the Selenium IDE. 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:

Without an explicit locator prefix, Selenium uses the following default strategies:

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.

filterType=argument

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

String-match Patterns

Various Pattern syntaxes are available for matching string values:

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.


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 addLocationStrategyAndWait(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 addSelectionAndWait(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 assertAlert(java.lang.String pattern)
           
 void assertAlertNotPresent()
           
 void assertAlertPresent()
           
 void assertAllButtons(java.lang.String pattern)
           
 void assertAllFields(java.lang.String pattern)
           
 void assertAllLinks(java.lang.String pattern)
           
 void assertAllWindowNames(java.lang.String pattern)
           
 void assertAllWindowTitles(java.lang.String pattern)
           
 void assertAttribute(java.lang.String attributeLocator, java.lang.String pattern)
           
 void assertAttributeFromAllWindows(java.lang.String attributeName, java.lang.String pattern)
           
 void assertBodyText(java.lang.String pattern)
           
 void assertChecked(java.lang.String locator)
           
 void assertConfirmation(java.lang.String pattern)
           
 void assertConfirmationNotPresent()
           
 void assertConfirmationPresent()
           
 void assertCookie(java.lang.String pattern)
           
 void assertCookieByName(java.lang.String name, java.lang.String pattern)
           
 void assertCookieNotPresent(java.lang.String name)
           
 void assertCookiePresent(java.lang.String name)
           
 void assertEditable(java.lang.String locator)
           
 void assertElementHeight(java.lang.String locator, java.lang.String pattern)
           
 void assertElementIndex(java.lang.String locator, java.lang.String pattern)
           
 void assertElementNotPresent(java.lang.String locator)
           
 void assertElementPositionLeft(java.lang.String locator, java.lang.String pattern)
           
 void assertElementPositionTop(java.lang.String locator, java.lang.String pattern)
           
 void assertElementPresent(java.lang.String locator)
           
 void assertElementWidth(java.lang.String locator, java.lang.String pattern)
           
 void assertErrorOnNext(java.lang.String message)
          Tell Selenium to expect an error on the next command execution.
 void assertErrorOnNextAndWait(java.lang.String message)
          Tell Selenium to expect an error on the next command execution.
 void assertEval(java.lang.String script, java.lang.String pattern)
           
 void assertExpression(java.lang.String expression, java.lang.String pattern)
           
 void assertFailureOnNext(java.lang.String message)
          Tell Selenium to expect a failure on the next command execution.
 void assertFailureOnNextAndWait(java.lang.String message)
          Tell Selenium to expect a failure on the next command execution.
 void assertHtmlSource(java.lang.String pattern)
           
 void assertLocation(java.lang.String pattern)
           
 void assertNotAlert(java.lang.String pattern)
           
 void assertNotAlertPresent()
           
 void assertNotAllButtons(java.lang.String pattern)
           
 void assertNotAllFields(java.lang.String pattern)
           
 void assertNotAllLinks(java.lang.String pattern)
           
 void assertNotAllWindowNames(java.lang.String pattern)
           
 void assertNotAllWindowTitles(java.lang.String pattern)
           
 void assertNotAttribute(java.lang.String attributeLocator, java.lang.String pattern)
           
 void assertNotAttributeFromAllWindows(java.lang.String attributeName, java.lang.String pattern)
           
 void assertNotBodyText(java.lang.String pattern)
           
 void assertNotChecked(java.lang.String locator)
           
 void assertNotConfirmation(java.lang.String pattern)
           
 void assertNotConfirmationPresent()
           
 void assertNotCookie(java.lang.String pattern)
           
 void assertNotCookieByName(java.lang.String name, java.lang.String pattern)
           
 void assertNotCookiePresent(java.lang.String name)
           
 void assertNotEditable(java.lang.String locator)
           
 void assertNotElementHeight(java.lang.String locator, java.lang.String pattern)
           
 void assertNotElementIndex(java.lang.String locator, java.lang.String pattern)
           
 void assertNotElementPositionLeft(java.lang.String locator, java.lang.String pattern)
           
 void assertNotElementPositionTop(java.lang.String locator, java.lang.String pattern)
           
 void assertNotElementPresent(java.lang.String locator)
           
 void assertNotElementWidth(java.lang.String locator, java.lang.String pattern)
           
 void assertNotEval(java.lang.String script, java.lang.String pattern)
           
 void assertNotExpression(java.lang.String expression, java.lang.String pattern)
           
 void assertNotHtmlSource(java.lang.String pattern)
           
 void assertNotLocation(java.lang.String pattern)
           
 void assertNotOrdered(java.lang.String locator1, java.lang.String locator2)
           
 void assertNotPromptPresent()
           
 void assertNotSelectedId(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertNotSelectedIds(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertNotSelectedIndex(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertNotSelectedIndexes(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertNotSelectedLabel(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertNotSelectedLabels(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertNotSelectedValue(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertNotSelectedValues(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertNotSelectOptions(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertNotSomethingSelected(java.lang.String selectLocator)
           
 void assertNotSpeed(java.lang.String pattern)
           
 void assertNotTable(java.lang.String tableCellAddress, java.lang.String pattern)
           
 void assertNotText(java.lang.String locator, java.lang.String pattern)
           
 void assertNotTextPresent(java.lang.String pattern)
           
 void assertNotTitle(java.lang.String pattern)
           
 void assertNotValue(java.lang.String locator, java.lang.String pattern)
           
 void assertNotVisible(java.lang.String locator)
           
 void assertNotXpathCount(java.lang.String xpath, java.lang.String pattern)
           
 void assertOrdered(java.lang.String locator1, java.lang.String locator2)
           
 void assertPromptNotPresent()
           
 void assertPromptPresent()
           
 void assertSelected(java.lang.String selectLocator, java.lang.String optionLocator)
          Verifies that the selected option of a drop-down satisfies the optionSpecifier.
 void assertSelectedAndWait(java.lang.String selectLocator, java.lang.String optionLocator)
          Verifies that the selected option of a drop-down satisfies the optionSpecifier.
 void assertSelectedId(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertSelectedIds(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertSelectedIndex(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertSelectedIndexes(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertSelectedLabel(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertSelectedLabels(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertSelectedValue(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertSelectedValues(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertSelectOptions(java.lang.String selectLocator, java.lang.String pattern)
           
 void assertSomethingSelected(java.lang.String selectLocator)
           
 void assertSpeed(java.lang.String pattern)
           
 void assertTable(java.lang.String tableCellAddress, java.lang.String pattern)
           
 void assertText(java.lang.String locator, java.lang.String pattern)
           
 void assertTextNotPresent(java.lang.String pattern)
           
 void assertTextPresent(java.lang.String pattern)
           
 void assertTitle(java.lang.String pattern)
           
 void assertValue(java.lang.String locator, java.lang.String pattern)
           
 void assertVisible(java.lang.String locator)
           
 void assertXpathCount(java.lang.String xpath, java.lang.String pattern)
           
 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 assignIdAndWait(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 check(java.lang.String locator)
          Check a toggle-button (checkbox/radio)
 void checkAndWait(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 chooseCancelOnNextConfirmationAndWait()
           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 chooseOkOnNextConfirmationAndWait()
           Undo the effect of calling chooseCancelOnNextConfirmation.
 void click(java.lang.String locator)
          Clicks on a link, button, checkbox or radio button.
 void clickAndWait(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 clickAtAndWait(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 closeAndWait()
          Simulates the user clicking the "close" button in the titlebar of a popup window or tab.
 void contextMenu(java.lang.String locator)
          Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
 void contextMenuAndWait(java.lang.String locator)
          Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
 void contextMenuAt(java.lang.String locator, java.lang.String coordString)
          Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
 void contextMenuAtAndWait(java.lang.String locator, java.lang.String coordString)
          Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
 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 createCookieAndWait(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 deleteAllVisibleCookies()
          Calls deleteCookie with recurse=true on all cookies visible to the current page.
 void deleteAllVisibleCookiesAndWait()
          Calls deleteCookie with recurse=true on all cookies visible to the current page.
 void deleteCookie(java.lang.String name, java.lang.String optionsString)
          Delete a named cookie with specified path and domain.
 void deleteCookieAndWait(java.lang.String name, java.lang.String optionsString)
          Delete a named cookie with specified path and domain.
 void doubleClick(java.lang.String locator)
          Double clicks on a link, button, checkbox or radio button.
 void doubleClickAndWait(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 doubleClickAtAndWait(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 dragAndDropAndWait(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 dragAndDropToObjectAndWait(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 dragdropAndWait(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.
 void fireEventAndWait(java.lang.String locator, java.lang.String eventName)
          Explicitly simulate an event, to trigger the corresponding "onevent" handler.
 SeleniumFlash flash(java.lang.String id)
          Returns a flash-selenium object that allows for easier control over ExternalInterface enabled flash objects.
 void focus(java.lang.String locator)
          Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field.
 void focusAndWait(java.lang.String locator)
          Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field.
 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[] 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.String getCookieByName(java.lang.String name)
          Returns the value of the cookie with the specified name, or throws an error if the cookie is not present.
 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.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.
 java.lang.String 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).
 WebDriver getWebDriver()
          Return the underlying WebDriver instance.
 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 goBackAndWait()
          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.
 void highlightAndWait(java.lang.String locator)
          Briefly changes the backgroundColor of the specified element yellow.
 void ignoreAttributesWithoutValueAndWait(java.lang.String ignore)
          Specifies whether Selenium will ignore xpath attributes that have no value, i.e.
 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 isCookiePresent(java.lang.String name)
          Returns true if a cookie with the specified name is present, or false otherwise.
 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 mouseDown(java.lang.String locator)
          Simulates a user pressing the left mouse button (without releasing it yet) on the specified element.
 void mouseDownAndWait(java.lang.String locator)
          Simulates a user pressing the left 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 left mouse button (without releasing it yet) at the specified location.
 void mouseDownAtAndWait(java.lang.String locator, java.lang.String coordString)
          Simulates a user pressing the left mouse button (without releasing it yet) at the specified location.
 void mouseDownRight(java.lang.String locator)
          Simulates a user pressing the right mouse button (without releasing it yet) on the specified element.
 void mouseDownRightAndWait(java.lang.String locator)
          Simulates a user pressing the right mouse button (without releasing it yet) on the specified element.
 void mouseDownRightAt(java.lang.String locator, java.lang.String coordString)
          Simulates a user pressing the right mouse button (without releasing it yet) at the specified location.
 void mouseDownRightAtAndWait(java.lang.String locator, java.lang.String coordString)
          Simulates a user pressing the right 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 mouseMoveAndWait(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 mouseMoveAtAndWait(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 mouseOutAndWait(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 mouseOverAndWait(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 mouseUpAndWait(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 mouseUpAtAndWait(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 mouseUpRight(java.lang.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.
 void mouseUpRightAndWait(java.lang.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.
 void mouseUpRightAt(java.lang.String locator, java.lang.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.
 void mouseUpRightAtAndWait(java.lang.String locator, java.lang.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.
 void open(java.lang.String url)
          Opens an URL in the test frame.
 void openAndWait(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 openWindowAndWait(java.lang.String url, java.lang.String windowID)
          Opens a popup window (if a window with that ID isn't already open).
 void pause(java.lang.String waitTime)
          Wait for the specified amount of time (in milliseconds)
 void pauseAndWait(java.lang.String waitTime)
          Wait for the specified amount of time (in milliseconds)
 void refresh()
          Simulates the user clicking the "Refresh" button on their browser.
 void refreshAndWait()
          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 removeAllSelectionsAndWait(java.lang.String locator)
          Unselects all of the selected options in a multi-select element.
 void removeScript(java.lang.String scriptTagId)
          Removes a script tag from the Selenium document identified by the given id.
 void removeScriptAndWait(java.lang.String scriptTagId)
          Removes a script tag from the Selenium document identified by the given id.
 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 removeSelectionAndWait(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 rollup(java.lang.String rollupName, java.lang.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.
 void rollupAndWait(java.lang.String rollupName, java.lang.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.
 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 runScriptAndWait(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 selectAndWait(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 selectFrameAndWait(java.lang.String locator)
          Selects a frame within the current window.
 void selectWindow(java.lang.String windowID)
          Selects a popup window using a window locator; once a popup window has been selected, all commands go to that window.
 void selectWindowAndWait(java.lang.String windowID)
          Selects a popup window using a window locator; 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 setBrowserLogLevelAndWait(java.lang.String logLevel)
          Sets the threshold for browser-side logging messages; log messages beneath this threshold will be discarded.
 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 setCursorPositionAndWait(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 setMouseSpeedAndWait(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 setSpeedAndWait(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 store(java.lang.String expression, java.lang.String variableName)
          This command is a synonym for storeExpression.
 void storeAlert(java.lang.String variableName)
           
 void storeAlertPresent(java.lang.String variableName)
           
 void storeAttribute(java.lang.String attributeLocator, java.lang.String variableName)
           
 void storeAttributeFromAllWindows(java.lang.String attributeName, java.lang.String variableName)
           
 void storeBodyText(java.lang.String variableName)
           
 void storeChecked(java.lang.String locator, java.lang.String variableName)
           
 void storeConfirmation(java.lang.String variableName)
           
 void storeConfirmationPresent(java.lang.String variableName)
           
 void storeCookie(java.lang.String variableName)
           
 void storeCookieByName(java.lang.String name, java.lang.String variableName)
           
 void storeCookiePresent(java.lang.String name, java.lang.String variableName)
           
 void storeEditable(java.lang.String locator, java.lang.String variableName)
           
 void storeElementHeight(java.lang.String locator, java.lang.String variableName)
           
 void storeElementIndex(java.lang.String locator, java.lang.String variableName)
           
 void storeElementPositionLeft(java.lang.String locator, java.lang.String variableName)
           
 void storeElementPositionTop(java.lang.String locator, java.lang.String variableName)
           
 void storeElementPresent(java.lang.String locator, java.lang.String variableName)
           
 void storeElementWidth(java.lang.String locator, java.lang.String variableName)
           
 void storeEval(java.lang.String script, java.lang.String variableName)
           
 void storeExpression(java.lang.String expression, java.lang.String variableName)
          NOTE: We don't support expressions like "javascript{new Date().getTime()}" for implementation reasons.
 void storeHtmlSource(java.lang.String variableName)
           
 void storeLocation(java.lang.String variableName)
           
 void storeOrdered(java.lang.String locator1, java.lang.String locator2, java.lang.String variableName)
           
 void storeSelectedId(java.lang.String selectLocator, java.lang.String variableName)
           
 void storeSelectedIds(java.lang.String selectLocator, java.lang.String variableName)
           
 void storeSelectedIndex(java.lang.String selectLocator, java.lang.String variableName)
           
 void storeSelectedIndexes(java.lang.String selectLocator, java.lang.String variableName)
           
 void storeSelectedLabel(java.lang.String selectLocator, java.lang.String variableName)
           
 void storeSelectedLabels(java.lang.String selectLocator, java.lang.String variableName)
           
 void storeSelectedValue(java.lang.String selectLocator, java.lang.String variableName)
           
 void storeSelectedValues(java.lang.String selectLocator, java.lang.String variableName)
           
 void storeSelectOptions(java.lang.String selectLocator, java.lang.String variableName)
           
 void storeSomethingSelected(java.lang.String selectLocator, java.lang.String variableName)
           
 void storeSpeed(java.lang.String variableName)
           
 void storeTable(java.lang.String tableCellAddress, java.lang.String variableName)
           
 void storeText(java.lang.String locator, java.lang.String variableName)
           
 void storeTextPresent(java.lang.String pattern, java.lang.String variableName)
           
 void storeTitle(java.lang.String variableName)
           
 void storeValue(java.lang.String locator, java.lang.String variableName)
           
 void storeVisible(java.lang.String locator, java.lang.String variableName)
           
 void storeXpathCount(java.lang.String xpath, java.lang.String variableName)
           
 void submit(java.lang.String formLocator)
          Submit the specified form.
 void submitAndWait(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 typeAndWait(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 typeKeysAndWait(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 uncheckAndWait(java.lang.String locator)
          Uncheck a toggle-button (checkbox/radio)
 void useXpathLibrary(java.lang.String libraryName)
          Allows choice of one of the available libraries.
 void useXpathLibraryAndWait(java.lang.String libraryName)
          Allows choice of one of the available libraries.
 void verifyAlert(java.lang.String pattern)
           
 void verifyAlertNotPresent()
           
 void verifyAlertPresent()
           
 void verifyAllButtons(java.lang.String pattern)
           
 void verifyAllFields(java.lang.String pattern)
           
 void verifyAllLinks(java.lang.String pattern)
           
 void verifyAllWindowNames(java.lang.String pattern)
           
 void verifyAllWindowTitles(java.lang.String pattern)
           
 void verifyAttribute(java.lang.String attributeLocator, java.lang.String pattern)
           
 void verifyAttributeFromAllWindows(java.lang.String attributeName, java.lang.String pattern)
           
 void verifyBodyText(java.lang.String pattern)
           
 void verifyChecked(java.lang.String locator)
           
 void verifyConfirmation(java.lang.String pattern)
           
 void verifyConfirmationNotPresent()
           
 void verifyConfirmationPresent()
           
 void verifyCookie(java.lang.String pattern)
           
 void verifyCookieByName(java.lang.String name, java.lang.String pattern)
           
 void verifyCookieNotPresent(java.lang.String name)
           
 void verifyCookiePresent(java.lang.String name)
           
 void verifyEditable(java.lang.String locator)
           
 void verifyElementHeight(java.lang.String locator, java.lang.String pattern)
           
 void verifyElementIndex(java.lang.String locator, java.lang.String pattern)
           
 void verifyElementNotPresent(java.lang.String locator)
           
 void verifyElementPositionLeft(java.lang.String locator, java.lang.String pattern)
           
 void verifyElementPositionTop(java.lang.String locator, java.lang.String pattern)
           
 void verifyElementPresent(java.lang.String locator)
           
 void verifyElementWidth(java.lang.String locator, java.lang.String pattern)
           
 void verifyEval(java.lang.String script, java.lang.String pattern)
           
 void verifyExpression(java.lang.String expression, java.lang.String pattern)
           
 void verifyHtmlSource(java.lang.String pattern)
           
 void verifyLocation(java.lang.String pattern)
           
 void verifyNotAlert(java.lang.String pattern)
           
 void verifyNotAlertPresent()
           
 void verifyNotAllButtons(java.lang.String pattern)
           
 void verifyNotAllFields(java.lang.String pattern)
           
 void verifyNotAllLinks(java.lang.String pattern)
           
 void verifyNotAllWindowNames(java.lang.String pattern)
           
 void verifyNotAllWindowTitles(java.lang.String pattern)
           
 void verifyNotAttribute(java.lang.String attributeLocator, java.lang.String pattern)
           
 void verifyNotAttributeFromAllWindows(java.lang.String attributeName, java.lang.String pattern)
           
 void verifyNotBodyText(java.lang.String pattern)
           
 void verifyNotChecked(java.lang.String locator)
           
 void verifyNotConfirmation(java.lang.String pattern)
           
 void verifyNotConfirmationPresent()
           
 void verifyNotCookie(java.lang.String pattern)
           
 void verifyNotCookieByName(java.lang.String name, java.lang.String pattern)
           
 void verifyNotCookiePresent(java.lang.String name)
           
 void verifyNotEditable(java.lang.String locator)
           
 void verifyNotElementHeight(java.lang.String locator, java.lang.String pattern)
           
 void verifyNotElementIndex(java.lang.String locator, java.lang.String pattern)
           
 void verifyNotElementPositionLeft(java.lang.String locator, java.lang.String pattern)
           
 void verifyNotElementPositionTop(java.lang.String locator, java.lang.String pattern)
           
 void verifyNotElementPresent(java.lang.String locator)
           
 void verifyNotElementWidth(java.lang.String locator, java.lang.String pattern)
           
 void verifyNotEval(java.lang.String script, java.lang.String pattern)
           
 void verifyNotExpression(java.lang.String expression, java.lang.String pattern)
           
 void verifyNotHtmlSource(java.lang.String pattern)
           
 void verifyNotLocation(java.lang.String pattern)
           
 void verifyNotOrdered(java.lang.String locator1, java.lang.String locator2)
           
 void verifyNotPromptPresent()
           
 void verifyNotSelectedId(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifyNotSelectedIds(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifyNotSelectedIndex(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifyNotSelectedIndexes(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifyNotSelectedLabel(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifyNotSelectedLabels(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifyNotSelectedValue(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifyNotSelectedValues(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifyNotSelectOptions(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifyNotSomethingSelected(java.lang.String selectLocator)
           
 void verifyNotSpeed(java.lang.String pattern)
           
 void verifyNotTable(java.lang.String tableCellAddress, java.lang.String pattern)
           
 void verifyNotText(java.lang.String locator, java.lang.String pattern)
           
 void verifyNotTextPresent(java.lang.String pattern)
           
 void verifyNotTitle(java.lang.String pattern)
           
 void verifyNotValue(java.lang.String locator, java.lang.String pattern)
           
 void verifyNotVisible(java.lang.String locator)
           
 void verifyNotXpathCount(java.lang.String xpath, java.lang.String pattern)
           
 void verifyOrdered(java.lang.String locator1, java.lang.String locator2)
           
 void verifyPromptNotPresent()
           
 void verifyPromptPresent()
           
 void verifySelectedId(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifySelectedIds(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifySelectedIndex(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifySelectedIndexes(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifySelectedLabel(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifySelectedLabels(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifySelectedValue(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifySelectedValues(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifySelectOptions(java.lang.String selectLocator, java.lang.String pattern)
           
 void verifySomethingSelected(java.lang.String selectLocator)
           
 void verifySpeed(java.lang.String pattern)
           
 void verifyTable(java.lang.String tableCellAddress, java.lang.String pattern)
           
 void verifyText(java.lang.String locator, java.lang.String pattern)
           
 void verifyTextNotPresent(java.lang.String pattern)
           
 void verifyTextPresent(java.lang.String pattern)
           
 void verifyTitle(java.lang.String pattern)
           
 void verifyValue(java.lang.String locator, java.lang.String pattern)
           
 void verifyVisible(java.lang.String locator)
           
 void verifyXpathCount(java.lang.String xpath, java.lang.String pattern)
           
 void waitForAlert(java.lang.String pattern)
           
 void waitForAlertNotPresent()
           
 void waitForAlertPresent()
           
 void waitForAllButtons(java.lang.String pattern)
           
 void waitForAllFields(java.lang.String pattern)
           
 void waitForAllLinks(java.lang.String pattern)
           
 void waitForAllWindowNames(java.lang.String pattern)
           
 void waitForAllWindowTitles(java.lang.String pattern)
           
 void waitForAttribute(java.lang.String attributeLocator, java.lang.String pattern)
           
 void waitForAttributeFromAllWindows(java.lang.String attributeName, java.lang.String pattern)
           
 void waitForBodyText(java.lang.String pattern)
           
 void waitForChecked(java.lang.String locator)
           
 void waitForCondition(java.lang.String script, java.lang.String timeout)
          Runs the specified JavaScript snippet repeatedly until it evaluates to "true".
 void waitForConditionAndWait(java.lang.String script, java.lang.String timeout)
          Runs the specified JavaScript snippet repeatedly until it evaluates to "true".
 void waitForConfirmation(java.lang.String pattern)
           
 void waitForConfirmationNotPresent()
           
 void waitForConfirmationPresent()
           
 void waitForCookie(java.lang.String pattern)
           
 void waitForCookieByName(java.lang.String name, java.lang.String pattern)
           
 void waitForCookieNotPresent(java.lang.String name)
           
 void waitForCookiePresent(java.lang.String name)
           
 void waitForEditable(java.lang.String locator)
           
 void waitForElementHeight(java.lang.String locator, java.lang.String pattern)
           
 void waitForElementIndex(java.lang.String locator, java.lang.String pattern)
           
 void waitForElementNotPresent(java.lang.String locator)
           
 void waitForElementPositionLeft(java.lang.String locator, java.lang.String pattern)
           
 void waitForElementPositionTop(java.lang.String locator, java.lang.String pattern)
           
 void waitForElementPresent(java.lang.String locator)
           
 void waitForElementWidth(java.lang.String locator, java.lang.String pattern)
           
 void waitForEval(java.lang.String script, java.lang.String pattern)
           
 void waitForExpression(java.lang.String expression, java.lang.String pattern)
           
 void waitForFrameToLoad(java.lang.String frameAddress, java.lang.String timeout)
          Waits for a new frame to load.
 void waitForFrameToLoadAndWait(java.lang.String frameAddress, java.lang.String timeout)
          Waits for a new frame to load.
 void waitForHtmlSource(java.lang.String pattern)
           
 void waitForLocation(java.lang.String pattern)
           
 void waitForNotAlert(java.lang.String pattern)
           
 void waitForNotAlertPresent()
           
 void waitForNotAllButtons(java.lang.String pattern)
           
 void waitForNotAllFields(java.lang.String pattern)
           
 void waitForNotAllLinks(java.lang.String pattern)
           
 void waitForNotAllWindowNames(java.lang.String pattern)
           
 void waitForNotAllWindowTitles(java.lang.String pattern)
           
 void waitForNotAttribute(java.lang.String attributeLocator, java.lang.String pattern)
           
 void waitForNotAttributeFromAllWindows(java.lang.String attributeName, java.lang.String pattern)
           
 void waitForNotBodyText(java.lang.String pattern)
           
 void waitForNotChecked(java.lang.String locator)
           
 void waitForNotConfirmation(java.lang.String pattern)
           
 void waitForNotConfirmationPresent()
           
 void waitForNotCookie(java.lang.String pattern)
           
 void waitForNotCookieByName(java.lang.String name, java.lang.String pattern)
           
 void waitForNotCookiePresent(java.lang.String name)
           
 void waitForNotEditable(java.lang.String locator)
           
 void waitForNotElementHeight(java.lang.String locator, java.lang.String pattern)
           
 void waitForNotElementIndex(java.lang.String locator, java.lang.String pattern)
           
 void waitForNotElementPositionLeft(java.lang.String locator, java.lang.String pattern)
           
 void waitForNotElementPositionTop(java.lang.String locator, java.lang.String pattern)
           
 void waitForNotElementPresent(java.lang.String locator)
           
 void waitForNotElementWidth(java.lang.String locator, java.lang.String pattern)
           
 void waitForNotEval(java.lang.String script, java.lang.String pattern)
           
 void waitForNotExpression(java.lang.String expression, java.lang.String pattern)
           
 void waitForNotHtmlSource(java.lang.String pattern)
           
 void waitForNotLocation(java.lang.String pattern)
           
 void waitForNotOrdered(java.lang.String locator1, java.lang.String locator2)
           
 void waitForNotPromptPresent()
           
 void waitForNotSelectedId(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForNotSelectedIds(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForNotSelectedIndex(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForNotSelectedIndexes(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForNotSelectedLabel(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForNotSelectedLabels(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForNotSelectedValue(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForNotSelectedValues(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForNotSelectOptions(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForNotSomethingSelected(java.lang.String selectLocator)
           
 void waitForNotSpeed(java.lang.String pattern)
           
 void waitForNotTable(java.lang.String tableCellAddress, java.lang.String pattern)
           
 void waitForNotText(java.lang.String locator, java.lang.String pattern)
           
 void waitForNotTextPresent(java.lang.String pattern)
           
 void waitForNotTitle(java.lang.String pattern)
           
 void waitForNotValue(java.lang.String locator, java.lang.String pattern)
           
 void waitForNotVisible(java.lang.String locator)
           
 void waitForNotXpathCount(java.lang.String xpath, java.lang.String pattern)
           
 void waitForOrdered(java.lang.String locator1, java.lang.String locator2)
           
 void waitForPageToLoad(java.lang.String timeout)
          Waits for a new page to load.
 void waitForPageToLoadAndWait(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 waitForPopUpAndWait(java.lang.String windowID, java.lang.String timeout)
          Waits for a popup window to appear and load up.
 void waitForPromptNotPresent()
           
 void waitForPromptPresent()
           
 void waitForSelectedId(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForSelectedIds(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForSelectedIndex(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForSelectedIndexes(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForSelectedLabel(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForSelectedLabels(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForSelectedValue(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForSelectedValues(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForSelectOptions(java.lang.String selectLocator, java.lang.String pattern)
           
 void waitForSomethingSelected(java.lang.String selectLocator)
           
 void waitForSpeed(java.lang.String pattern)
           
 void waitForTable(java.lang.String tableCellAddress, java.lang.String pattern)
           
 void waitForText(java.lang.String locator, java.lang.String pattern)
           
 void waitForTextNotPresent(java.lang.String pattern)
           
 void waitForTextPresent(java.lang.String pattern)
           
 void waitForTitle(java.lang.String pattern)
           
 void waitForValue(java.lang.String locator, java.lang.String pattern)
           
 void waitForVisible(java.lang.String locator)
           
 void waitForXpathCount(java.lang.String xpath, java.lang.String pattern)
           
 void windowFocus()
          Gives focus to the currently selected window
 void windowFocusAndWait()
          Gives focus to the currently selected window
 void windowMaximize()
          Resize currently selected window to take up the entire screen
 void windowMaximizeAndWait()
          Resize currently selected window to take up the entire screen
 

Method Detail

click

void click(java.lang.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:
locator - an element locator

clickAndWait

void clickAndWait(java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator

doubleClick

void doubleClick(java.lang.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:
locator - an element locator

doubleClickAndWait

void doubleClickAndWait(java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator

contextMenu

void contextMenu(java.lang.String locator)
Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).

Parameters:
locator - an element locator

contextMenuAndWait

void contextMenuAndWait(java.lang.String locator)
Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator

clickAt

void clickAt(java.lang.String locator,
             java.lang.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:
locator - an element locator
coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

clickAtAndWait

void clickAtAndWait(java.lang.String locator,
                    java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

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

doubleClickAt

void doubleClickAt(java.lang.String locator,
                   java.lang.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:
locator - an element locator
coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

doubleClickAtAndWait

void doubleClickAtAndWait(java.lang.String locator,
                          java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

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

contextMenuAt

void contextMenuAt(java.lang.String locator,
                   java.lang.String coordString)
Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).

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

contextMenuAtAndWait

void contextMenuAtAndWait(java.lang.String locator,
                          java.lang.String coordString)
Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

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

fireEvent

void fireEvent(java.lang.String locator,
               java.lang.String eventName)
Explicitly simulate an event, to trigger the corresponding "onevent" handler.

Parameters:
locator - an element locator
eventName - the event name, e.g. "focus" or "blur"

fireEventAndWait

void fireEventAndWait(java.lang.String locator,
                      java.lang.String eventName)
Explicitly simulate an event, to trigger the corresponding "onevent" handler.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator
eventName - the event name, e.g. "focus" or "blur"

focus

void focus(java.lang.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:
locator - an element locator

focusAndWait

void focusAndWait(java.lang.String locator)
Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator

mouseOver

void mouseOver(java.lang.String locator)
Simulates a user hovering a mouse over the specified element.

Parameters:
locator - an element locator

mouseOverAndWait

void mouseOverAndWait(java.lang.String locator)
Simulates a user hovering a mouse over the specified element.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator

mouseOut

void mouseOut(java.lang.String locator)
Simulates a user moving the mouse pointer away from the specified element.

Parameters:
locator - an element locator

mouseOutAndWait

void mouseOutAndWait(java.lang.String locator)
Simulates a user moving the mouse pointer away from the specified element.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator

mouseDown

void mouseDown(java.lang.String locator)
Simulates a user pressing the left mouse button (without releasing it yet) on the specified element.

Parameters:
locator - an element locator

mouseDownAndWait

void mouseDownAndWait(java.lang.String locator)
Simulates a user pressing the left mouse button (without releasing it yet) on the specified element.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator

mouseDownRight

void mouseDownRight(java.lang.String locator)
Simulates a user pressing the right mouse button (without releasing it yet) on the specified element.

Parameters:
locator - an element locator

mouseDownRightAndWait

void mouseDownRightAndWait(java.lang.String locator)
Simulates a user pressing the right mouse button (without releasing it yet) on the specified element.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator

mouseDownAt

void mouseDownAt(java.lang.String locator,
                 java.lang.String coordString)
Simulates a user pressing the left mouse button (without releasing it yet) at the specified location.

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

mouseDownAtAndWait

void mouseDownAtAndWait(java.lang.String locator,
                        java.lang.String coordString)
Simulates a user pressing the left mouse button (without releasing it yet) at the specified location.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

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

mouseDownRightAt

void mouseDownRightAt(java.lang.String locator,
                      java.lang.String coordString)
Simulates a user pressing the right mouse button (without releasing it yet) at the specified location.

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

mouseDownRightAtAndWait

void mouseDownRightAtAndWait(java.lang.String locator,
                             java.lang.String coordString)
Simulates a user pressing the right mouse button (without releasing it yet) at the specified location.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

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

mouseUp

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.

Parameters:
locator - an element locator

mouseUpAndWait

void mouseUpAndWait(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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator

mouseUpRight

void mouseUpRight(java.lang.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:
locator - an element locator

mouseUpRightAndWait

void mouseUpRightAndWait(java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator

mouseUpAt

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.

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

mouseUpAtAndWait

void mouseUpAtAndWait(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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

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

mouseUpRightAt

void mouseUpRightAt(java.lang.String locator,
                    java.lang.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:
locator - an element locator
coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

mouseUpRightAtAndWait

void mouseUpRightAtAndWait(java.lang.String locator,
                           java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

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

mouseMove

void mouseMove(java.lang.String locator)
Simulates a user pressing the mouse button (without releasing it yet) on the specified element.

Parameters:
locator - an element locator

mouseMoveAndWait

void mouseMoveAndWait(java.lang.String locator)
Simulates a user pressing the mouse button (without releasing it yet) on the specified element.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator

mouseMoveAt

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.

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

mouseMoveAtAndWait

void mouseMoveAtAndWait(java.lang.String locator,
                        java.lang.String coordString)
Simulates a user pressing the mouse button (without releasing it yet) on the specified element.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

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

type

void type(java.lang.String locator,
          java.lang.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:
locator - an element locator
value - the value to type

typeAndWait

void typeAndWait(java.lang.String locator,
                 java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator
value - the value to type

typeKeys

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.

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:
locator - an element locator
value - the value to type

typeKeysAndWait

void typeKeysAndWait(java.lang.String locator,
                     java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator
value - the value to type

setSpeedAndWait

void setSpeedAndWait(java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
value - the number of milliseconds to pause after operation

getSpeed

java.lang.String getSpeed()
Get execution speed (i.e., get the millisecond length of the delay following each selenium operation). By default, there is no such delay, i.e., the delay is 0 milliseconds. See also setSpeed.

Returns:
the speed

setSpeed

void setSpeed(java.lang.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:
value - the number of milliseconds to pause after operation

verifySpeed

void verifySpeed(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getSpeed()

assertSpeed

void assertSpeed(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getSpeed()

verifyNotSpeed

void verifyNotSpeed(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getSpeed()

assertNotSpeed

void assertNotSpeed(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getSpeed()

waitForSpeed

void waitForSpeed(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getSpeed()

waitForNotSpeed

void waitForNotSpeed(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getSpeed()

storeSpeed

void storeSpeed(java.lang.String variableName)
Parameters:
variableName - The variable name to store this value to
See Also:
getSpeed()

check

void check(java.lang.String locator)
Check a toggle-button (checkbox/radio)

Parameters:
locator - an element locator

checkAndWait

void checkAndWait(java.lang.String locator)
Check a toggle-button (checkbox/radio)

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator

uncheck

void uncheck(java.lang.String locator)
Uncheck a toggle-button (checkbox/radio)

Parameters:
locator - an element locator

uncheckAndWait

void uncheckAndWait(java.lang.String locator)
Uncheck a toggle-button (checkbox/radio)

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator

select

void select(java.lang.String selectLocator,
            java.lang.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.

If no option locator prefix is provided, the default behaviour is to match on label.

Parameters:
selectLocator - an element locator identifying a drop-down menu
optionLocator - an option locator (a label by default)

selectAndWait

void selectAndWait(java.lang.String selectLocator,
                   java.lang.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.

If no option locator prefix is provided, the default behaviour is to match on label.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
selectLocator - an element locator identifying a drop-down menu
optionLocator - an option locator (a label by default)

addSelection

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.

Parameters:
locator - an element locator identifying a multi-select box
optionLocator - an option locator (a label by default)
See Also:
for details of option locators

addSelectionAndWait

void addSelectionAndWait(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.

Parameters:
locator - an element locator identifying a multi-select box
optionLocator - an option locator (a label by default)
See Also:
for details of option locators

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.


removeSelection

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.

Parameters:
locator - an element locator identifying a multi-select box
optionLocator - an option locator (a label by default)
See Also:
for details of option locators

removeSelectionAndWait

void removeSelectionAndWait(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.

Parameters:
locator - an element locator identifying a multi-select box
optionLocator - an option locator (a label by default)
See Also:
for details of option locators

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.


removeAllSelections

void removeAllSelections(java.lang.String locator)
Unselects all of the selected options in a multi-select element.

Parameters:
locator - an element locator identifying a multi-select box

removeAllSelectionsAndWait

void removeAllSelectionsAndWait(java.lang.String locator)
Unselects all of the selected options in a multi-select element.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator identifying a multi-select box

submit

void submit(java.lang.String formLocator)
Submit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input "Search" forms.

Parameters:
formLocator - an element locator for the form you want to submit

submitAndWait

void submitAndWait(java.lang.String formLocator)
Submit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input "Search" forms.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
formLocator - an element locator for the form you want to submit

open

void open(java.lang.String url)
Opens an URL in the test frame. This accepts both relative and absolute URLs.

The "open" command waits for the page to load before proceeding, ie. the "AndWait" suffix is implicit.

Note: The URL must be on the same domain as the runner HTML due to security restrictions in the browser (Same Origin Policy). If you need to open an URL on another domain, use the Selenium Server to start a new browser session on that domain.

Parameters:
url - the URL to open; may be relative or absolute

openAndWait

void openAndWait(java.lang.String url)
Opens an URL in the test frame. This accepts both relative and absolute URLs.

The "open" command waits for the page to load before proceeding, ie. the "AndWait" suffix is implicit.

Note: The URL must be on the same domain as the runner HTML due to security restrictions in the browser (Same Origin Policy). If you need to open an URL on another domain, use the Selenium Server to start a new browser session on that domain.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
url - the URL to open; may be relative or absolute

openWindow

void openWindow(java.lang.String url,
                java.lang.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.

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

Parameters:
url - the URL to open, which can be blank
windowID - the JavaScript window ID of the window to select

openWindowAndWait

void openWindowAndWait(java.lang.String url,
                       java.lang.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.

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

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
url - the URL to open, which can be blank
windowID - the JavaScript window ID of the window to select

selectWindow

void selectWindow(java.lang.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.

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:
windowID - the JavaScript window ID of the window to select

selectWindowAndWait

void selectWindowAndWait(java.lang.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.

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

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
windowID - the JavaScript window ID of the window to select

selectFrame

void selectFrame(java.lang.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".

You may also use a DOM expression to identify the frame you want directly, like this: dom=frames["main"].frames["subframe"]

Parameters:
locator - an element locator identifying a frame or iframe

selectFrameAndWait

void selectFrameAndWait(java.lang.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".

You may also use a DOM expression to identify the frame you want directly, like this: dom=frames["main"].frames["subframe"]

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator identifying a frame or iframe

waitForPopUp

void waitForPopUp(java.lang.String windowID,
                  java.lang.String timeout)
Waits for a popup window to appear and load up.

Parameters:
windowID - the JavaScript window "name" of the window that will appear (not the text of the title bar)
timeout - a timeout in milliseconds, after which the action will return with an error

waitForPopUpAndWait

void waitForPopUpAndWait(java.lang.String windowID,
                         java.lang.String timeout)
Waits for a popup window to appear and load up.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
windowID - the JavaScript window "name" of the window that will appear (not the text of the title bar)
timeout - a timeout in milliseconds, after which the action will return with an error

chooseCancelOnNextConfirmation

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

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


chooseCancelOnNextConfirmationAndWait

void chooseCancelOnNextConfirmationAndWait()

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.

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

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.


chooseOkOnNextConfirmation

void chooseOkOnNextConfirmation()

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.

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


chooseOkOnNextConfirmationAndWait

void chooseOkOnNextConfirmationAndWait()

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.

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

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.


goBack

void goBack()
Simulates the user clicking the "back" button on their browser.


goBackAndWait

void goBackAndWait()
Simulates the user clicking the "back" button on their browser.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.


refresh

void refresh()
Simulates the user clicking the "Refresh" button on their browser.


refreshAndWait

void refreshAndWait()
Simulates the user clicking the "Refresh" button on their browser.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.


close

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


closeAndWait

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

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.


isAlertPresent

boolean isAlertPresent()
Has an alert occurred?

This function never throws an exception

Returns:
true if alert is present, false otherwise

verifyAlertPresent

void verifyAlertPresent()
See Also:
isAlertPresent()

assertAlertPresent

void assertAlertPresent()
See Also:
isAlertPresent()

verifyNotAlertPresent

void verifyNotAlertPresent()
See Also:
isAlertPresent()

verifyAlertNotPresent

void verifyAlertNotPresent()
See Also:
isAlertPresent()

assertNotAlertPresent

void assertNotAlertPresent()
See Also:
isAlertPresent()

assertAlertNotPresent

void assertAlertNotPresent()
See Also:
isAlertPresent()

waitForAlertPresent

void waitForAlertPresent()
See Also:
isAlertPresent()

waitForNotAlertPresent

void waitForNotAlertPresent()
See Also:
isAlertPresent()

waitForAlertNotPresent

void waitForAlertNotPresent()
See Also:
isAlertPresent()

storeAlertPresent

void storeAlertPresent(java.lang.String variableName)
Parameters:
variableName - The variable name to store this value to
See Also:
isAlertPresent()

isPromptPresent

boolean isPromptPresent()
Has a prompt occurred?

This function never throws an exception

Returns:
true if prompt is present, false otherwise

verifyPromptPresent

void verifyPromptPresent()
See Also:
isPromptPresent()

assertPromptPresent

void assertPromptPresent()
See Also:
isPromptPresent()

verifyNotPromptPresent

void verifyNotPromptPresent()
See Also:
isPromptPresent()

verifyPromptNotPresent

void verifyPromptNotPresent()
See Also:
isPromptPresent()

assertNotPromptPresent

void assertNotPromptPresent()
See Also:
isPromptPresent()

assertPromptNotPresent

void assertPromptNotPresent()
See Also:
isPromptPresent()

waitForPromptPresent

void waitForPromptPresent()
See Also:
isPromptPresent()

waitForNotPromptPresent

void waitForNotPromptPresent()
See Also:
isPromptPresent()

waitForPromptNotPresent

void waitForPromptNotPresent()
See Also:
isPromptPresent()

isConfirmationPresent

boolean isConfirmationPresent()
Has confirm() been called?

This function never throws an exception

Returns:
true if confirmation has been called, false otherwise

verifyConfirmationPresent

void verifyConfirmationPresent()
See Also:
isConfirmationPresent()

assertConfirmationPresent

void assertConfirmationPresent()
See Also:
isConfirmationPresent()

verifyNotConfirmationPresent

void verifyNotConfirmationPresent()
See Also:
isConfirmationPresent()

verifyConfirmationNotPresent

void verifyConfirmationNotPresent()
See Also:
isConfirmationPresent()

assertNotConfirmationPresent

void assertNotConfirmationPresent()
See Also:
isConfirmationPresent()

assertConfirmationNotPresent

void assertConfirmationNotPresent()
See Also:
isConfirmationPresent()

waitForConfirmationPresent

void waitForConfirmationPresent()
See Also:
isConfirmationPresent()

waitForNotConfirmationPresent

void waitForNotConfirmationPresent()
See Also:
isConfirmationPresent()

waitForConfirmationNotPresent

void waitForConfirmationNotPresent()
See Also:
isConfirmationPresent()

storeConfirmationPresent

void storeConfirmationPresent(java.lang.String variableName)
Parameters:
variableName - The variable name to store this value to
See Also:
isConfirmationPresent()

getAlert

java.lang.String getAlert()
Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts.

Getting an alert has the same effect as manually clicking OK. If an alert is generated but you do not 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.

Returns:
the Alert message

verifyAlert

void verifyAlert(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAlert()

assertAlert

void assertAlert(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAlert()

verifyNotAlert

void verifyNotAlert(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAlert()

assertNotAlert

void assertNotAlert(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAlert()

waitForAlert

void waitForAlert(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAlert()

waitForNotAlert

void waitForNotAlert(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAlert()

storeAlert

void storeAlert(java.lang.String variableName)
Parameters:
variableName - The variable name to store this value to
See Also:
getAlert()

getConfirmation

java.lang.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.

Returns:
the confirmation message

verifyConfirmation

void verifyConfirmation(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getConfirmation()

assertConfirmation

void assertConfirmation(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getConfirmation()

verifyNotConfirmation

void verifyNotConfirmation(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getConfirmation()

assertNotConfirmation

void assertNotConfirmation(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getConfirmation()

waitForConfirmation

void waitForConfirmation(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getConfirmation()

waitForNotConfirmation

void waitForNotConfirmation(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getConfirmation()

storeConfirmation

void storeConfirmation(java.lang.String variableName)
Parameters:
variableName - The variable name to store this value to
See Also:
getConfirmation()

getLocation

java.lang.String getLocation()
Gets the absolute URL of the current page.

Returns:
the absolute url of the current page

verifyLocation

void verifyLocation(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getLocation()

assertLocation

void assertLocation(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getLocation()

verifyNotLocation

void verifyNotLocation(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getLocation()

assertNotLocation

void assertNotLocation(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getLocation()

waitForLocation

void waitForLocation(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getLocation()

waitForNotLocation

void waitForNotLocation(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getLocation()

storeLocation

void storeLocation(java.lang.String variableName)
Parameters:
variableName - The variable name to store this value to
See Also:
getLocation()

getTitle

java.lang.String getTitle()
Gets the title of the current page.

Returns:
the titel of the current page

verifyTitle

void verifyTitle(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getTitle()

assertTitle

void assertTitle(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getTitle()

verifyNotTitle

void verifyNotTitle(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getTitle()

assertNotTitle

void assertNotTitle(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getTitle()

waitForTitle

void waitForTitle(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getTitle()

waitForNotTitle

void waitForNotTitle(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getTitle()

storeTitle

void storeTitle(java.lang.String variableName)
Parameters:
variableName - The variable name to store this value to
See Also:
getTitle()

getBodyText

java.lang.String getBodyText()
Gets the entire text of the page.

Returns:
the entire text of the page

verifyBodyText

void verifyBodyText(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getBodyText()

assertBodyText

void assertBodyText(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getBodyText()

verifyNotBodyText

void verifyNotBodyText(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getBodyText()

assertNotBodyText

void assertNotBodyText(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getBodyText()

waitForBodyText

void waitForBodyText(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getBodyText()

waitForNotBodyText

void waitForNotBodyText(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getBodyText()

storeBodyText

void storeBodyText(java.lang.String variableName)
Parameters:
variableName - The variable name to store this value to
See Also:
getBodyText()

getValue

java.lang.String getValue(java.lang.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:
locator - an element locator
Returns:
the value of the element's input field

verifyValue

void verifyValue(java.lang.String locator,
                 java.lang.String pattern)
Parameters:
locator - an element locator
pattern - The pattern to check
See Also:
getValue(java.lang.String)

assertValue

void assertValue(java.lang.String locator,
                 java.lang.String pattern)
Parameters:
locator - an element locator
pattern - The pattern to check
See Also:
getValue(java.lang.String)

verifyNotValue

void verifyNotValue(java.lang.String locator,
                    java.lang.String pattern)
Parameters:
locator - an element locator
pattern - The pattern to check
See Also:
getValue(java.lang.String)

assertNotValue

void assertNotValue(java.lang.String locator,
                    java.lang.String pattern)
Parameters:
locator - an element locator
pattern - The pattern to check
See Also:
getValue(java.lang.String)

waitForValue

void waitForValue(java.lang.String locator,
                  java.lang.String pattern)
Parameters:
locator - an element locator
pattern - The pattern to check
See Also:
getValue(java.lang.String)

waitForNotValue

void waitForNotValue(java.lang.String locator,
                     java.lang.String pattern)
Parameters:
locator - an element locator
pattern - The pattern to check
See Also:
getValue(java.lang.String)

storeValue

void storeValue(java.lang.String locator,
                java.lang.String variableName)
Parameters:
locator - an element locator
variableName - The variable name to store this value to
See Also:
getValue(java.lang.String)

getText

java.lang.String getText(java.lang.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:
locator - an element locator
Returns:
the text of the located element

verifyText

void verifyText(java.lang.String locator,
                java.lang.String pattern)
Parameters:
locator - an element locator
pattern - The pattern to check
See Also:
getText(java.lang.String)

assertText

void assertText(java.lang.String locator,
                java.lang.String pattern)
Parameters:
locator - an element locator
pattern - The pattern to check
See Also:
getText(java.lang.String)

verifyNotText

void verifyNotText(java.lang.String locator,
                   java.lang.String pattern)
Parameters:
locator - an element locator
pattern - The pattern to check
See Also:
getText(java.lang.String)

assertNotText

void assertNotText(java.lang.String locator,
                   java.lang.String pattern)
Parameters:
locator - an element locator
pattern - The pattern to check
See Also:
getText(java.lang.String)

waitForText

void waitForText(java.lang.String locator,
                 java.lang.String pattern)
Parameters:
locator - an element locator
pattern - The pattern to check
See Also:
getText(java.lang.String)

waitForNotText

void waitForNotText(java.lang.String locator,
                    java.lang.String pattern)
Parameters:
locator - an element locator
pattern - The pattern to check
See Also:
getText(java.lang.String)

storeText

void storeText(java.lang.String locator,
               java.lang.String variableName)
Parameters:
locator - an element locator
variableName - The variable name to store this value to
See Also:
getText(java.lang.String)

highlight

void highlight(java.lang.String locator)
Briefly changes the backgroundColor of the specified element yellow. Useful for debugging.

Parameters:
locator - an element locator

highlightAndWait

void highlightAndWait(java.lang.String locator)
Briefly changes the backgroundColor of the specified element yellow. Useful for debugging.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator

getEval

java.lang.String getEval(java.lang.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:
script - the JavaScript snippet to run
Returns:
get the result of evaluating the sepcified js snippet.

verifyEval

void verifyEval(java.lang.String script,
                java.lang.String pattern)
Parameters:
script - the JavaScript snippet to run
pattern - The pattern to check
See Also:
getEval(java.lang.String)

assertEval

void assertEval(java.lang.String script,
                java.lang.String pattern)
Parameters:
script - the JavaScript snippet to run
pattern - The pattern to check
See Also:
getEval(java.lang.String)

verifyNotEval

void verifyNotEval(java.lang.String script,
                   java.lang.String pattern)
Parameters:
script - the JavaScript snippet to run
pattern - The pattern to check
See Also:
getEval(java.lang.String)

assertNotEval

void assertNotEval(java.lang.String script,
                   java.lang.String pattern)
Parameters:
script - the JavaScript snippet to run
pattern - The pattern to check
See Also:
getEval(java.lang.String)

waitForEval

void waitForEval(java.lang.String script,
                 java.lang.String pattern)
Parameters:
script - the JavaScript snippet to run
pattern - The pattern to check
See Also:
getEval(java.lang.String)

waitForNotEval

void waitForNotEval(java.lang.String script,
                    java.lang.String pattern)
Parameters:
script - the JavaScript snippet to run
pattern - The pattern to check
See Also:
getEval(java.lang.String)

storeEval

void storeEval(java.lang.String script,
               java.lang.String variableName)
Parameters:
script - the JavaScript snippet to run
variableName - The variable name to store this value to
See Also:
getEval(java.lang.String)

isChecked

boolean isChecked(java.lang.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:
locator - an element locator pointing to a checkbox or radio button
Returns:
true if the button is checked, false otherwise

verifyChecked

void verifyChecked(java.lang.String locator)
Parameters:
locator - an element locator pointing to a checkbox or radio button
See Also:
isChecked(java.lang.String)

assertChecked

void assertChecked(java.lang.String locator)
Parameters:
locator - an element locator pointing to a checkbox or radio button
See Also:
isChecked(java.lang.String)

verifyNotChecked

void verifyNotChecked(java.lang.String locator)
Parameters:
locator - an element locator pointing to a checkbox or radio button
See Also:
isChecked(java.lang.String)

assertNotChecked

void assertNotChecked(java.lang.String locator)
Parameters:
locator - an element locator pointing to a checkbox or radio button
See Also:
isChecked(java.lang.String)

waitForChecked

void waitForChecked(java.lang.String locator)
Parameters:
locator - an element locator pointing to a checkbox or radio button
See Also:
isChecked(java.lang.String)

waitForNotChecked

void waitForNotChecked(java.lang.String locator)
Parameters:
locator - an element locator pointing to a checkbox or radio button
See Also:
isChecked(java.lang.String)

storeChecked

void storeChecked(java.lang.String locator,
                  java.lang.String variableName)
Parameters:
locator - an element locator pointing to a checkbox or radio button
variableName - The variable name to store this value to
See Also:
isChecked(java.lang.String)

getTable

java.lang.String getTable(java.lang.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:
tableCellAddress - a cell address, e.g. "foo.1.4"
Returns:
the text from a cell of a table

verifyTable

void verifyTable(java.lang.String tableCellAddress,
                 java.lang.String pattern)
Parameters:
tableCellAddress - a cell address, e.g. "foo.1.4"
pattern - The pattern to check
See Also:
getTable(java.lang.String)

assertTable

void assertTable(java.lang.String tableCellAddress,
                 java.lang.String pattern)
Parameters:
tableCellAddress - a cell address, e.g. "foo.1.4"
pattern - The pattern to check
See Also:
getTable(java.lang.String)

verifyNotTable

void verifyNotTable(java.lang.String tableCellAddress,
                    java.lang.String pattern)
Parameters:
tableCellAddress - a cell address, e.g. "foo.1.4"
pattern - The pattern to check
See Also:
getTable(java.lang.String)

assertNotTable

void assertNotTable(java.lang.String tableCellAddress,
                    java.lang.String pattern)
Parameters:
tableCellAddress - a cell address, e.g. "foo.1.4"
pattern - The pattern to check
See Also:
getTable(java.lang.String)

waitForTable

void waitForTable(java.lang.String tableCellAddress,
                  java.lang.String pattern)
Parameters:
tableCellAddress - a cell address, e.g. "foo.1.4"
pattern - The pattern to check
See Also:
getTable(java.lang.String)

waitForNotTable

void waitForNotTable(java.lang.String tableCellAddress,
                     java.lang.String pattern)
Parameters:
tableCellAddress - a cell address, e.g. "foo.1.4"
pattern - The pattern to check
See Also:
getTable(java.lang.String)

storeTable

void storeTable(java.lang.String tableCellAddress,
                java.lang.String variableName)
Parameters:
tableCellAddress - a cell address, e.g. "foo.1.4"
variableName - The variable name to store this value to
See Also:
getTable(java.lang.String)

getSelectedLabels

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.

Parameters:
selectLocator - an element locator identifying a drop-down menu
Returns:
the option labels

verifySelectedLabels

void verifySelectedLabels(java.lang.String selectLocator,
                          java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedLabels(java.lang.String)

assertSelectedLabels

void assertSelectedLabels(java.lang.String selectLocator,
                          java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedLabels(java.lang.String)

verifyNotSelectedLabels

void verifyNotSelectedLabels(java.lang.String selectLocator,
                             java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedLabels(java.lang.String)

assertNotSelectedLabels

void assertNotSelectedLabels(java.lang.String selectLocator,
                             java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedLabels(java.lang.String)

waitForSelectedLabels

void waitForSelectedLabels(java.lang.String selectLocator,
                           java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedLabels(java.lang.String)

waitForNotSelectedLabels

void waitForNotSelectedLabels(java.lang.String selectLocator,
                              java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedLabels(java.lang.String)

storeSelectedLabels

void storeSelectedLabels(java.lang.String selectLocator,
                         java.lang.String variableName)
Parameters:
selectLocator - an element locator identifying a drop-down menu
variableName - The variable name to store this value to
See Also:
getSelectedLabels(java.lang.String)

getSelectedLabel

java.lang.String getSelectedLabel(java.lang.String selectLocator)
Gets option label (visible text) for selected option in the specified select element.

Parameters:
selectLocator - an element locator identifying a drop-down menu
Returns:
the selected label

verifySelectedLabel

void verifySelectedLabel(java.lang.String selectLocator,
                         java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedLabel(java.lang.String)

assertSelectedLabel

void assertSelectedLabel(java.lang.String selectLocator,
                         java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedLabel(java.lang.String)

verifyNotSelectedLabel

void verifyNotSelectedLabel(java.lang.String selectLocator,
                            java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedLabel(java.lang.String)

assertNotSelectedLabel

void assertNotSelectedLabel(java.lang.String selectLocator,
                            java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedLabel(java.lang.String)

waitForSelectedLabel

void waitForSelectedLabel(java.lang.String selectLocator,
                          java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedLabel(java.lang.String)

waitForNotSelectedLabel

void waitForNotSelectedLabel(java.lang.String selectLocator,
                             java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedLabel(java.lang.String)

storeSelectedLabel

void storeSelectedLabel(java.lang.String selectLocator,
                        java.lang.String variableName)
Parameters:
selectLocator - an element locator identifying a drop-down menu
variableName - The variable name to store this value to
See Also:
getSelectedLabel(java.lang.String)

getSelectedValues

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.

Parameters:
selectLocator - an element locator identifying a drop-down menu
Returns:
all the option values

verifySelectedValues

void verifySelectedValues(java.lang.String selectLocator,
                          java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedValues(java.lang.String)

assertSelectedValues

void assertSelectedValues(java.lang.String selectLocator,
                          java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedValues(java.lang.String)

verifyNotSelectedValues

void verifyNotSelectedValues(java.lang.String selectLocator,
                             java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedValues(java.lang.String)

assertNotSelectedValues

void assertNotSelectedValues(java.lang.String selectLocator,
                             java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedValues(java.lang.String)

waitForSelectedValues

void waitForSelectedValues(java.lang.String selectLocator,
                           java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedValues(java.lang.String)

waitForNotSelectedValues

void waitForNotSelectedValues(java.lang.String selectLocator,
                              java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedValues(java.lang.String)

storeSelectedValues

void storeSelectedValues(java.lang.String selectLocator,
                         java.lang.String variableName)
Parameters:
selectLocator - an element locator identifying a drop-down menu
variableName - The variable name to store this value to
See Also:
getSelectedValues(java.lang.String)

getSelectedValue

java.lang.String getSelectedValue(java.lang.String selectLocator)
Gets option value (value attribute) for selected option in the specified select element.

Parameters:
selectLocator - an element locator identifying a drop-down menu
Returns:
the element's selected value's value

verifySelectedValue

void verifySelectedValue(java.lang.String selectLocator,
                         java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedValue(java.lang.String)

assertSelectedValue

void assertSelectedValue(java.lang.String selectLocator,
                         java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedValue(java.lang.String)

verifyNotSelectedValue

void verifyNotSelectedValue(java.lang.String selectLocator,
                            java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedValue(java.lang.String)

assertNotSelectedValue

void assertNotSelectedValue(java.lang.String selectLocator,
                            java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedValue(java.lang.String)

waitForSelectedValue

void waitForSelectedValue(java.lang.String selectLocator,
                          java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedValue(java.lang.String)

waitForNotSelectedValue

void waitForNotSelectedValue(java.lang.String selectLocator,
                             java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedValue(java.lang.String)

storeSelectedValue

void storeSelectedValue(java.lang.String selectLocator,
                        java.lang.String variableName)
Parameters:
selectLocator - an element locator identifying a drop-down menu
variableName - The variable name to store this value to
See Also:
getSelectedValue(java.lang.String)

getSelectedIndexes

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.

Parameters:
selectLocator - an element locator identifying a drop-down menu
Returns:
all option indexes

verifySelectedIndexes

void verifySelectedIndexes(java.lang.String selectLocator,
                           java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIndexes(java.lang.String)

assertSelectedIndexes

void assertSelectedIndexes(java.lang.String selectLocator,
                           java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIndexes(java.lang.String)

verifyNotSelectedIndexes

void verifyNotSelectedIndexes(java.lang.String selectLocator,
                              java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIndexes(java.lang.String)

assertNotSelectedIndexes

void assertNotSelectedIndexes(java.lang.String selectLocator,
                              java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIndexes(java.lang.String)

waitForSelectedIndexes

void waitForSelectedIndexes(java.lang.String selectLocator,
                            java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIndexes(java.lang.String)

waitForNotSelectedIndexes

void waitForNotSelectedIndexes(java.lang.String selectLocator,
                               java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIndexes(java.lang.String)

storeSelectedIndexes

void storeSelectedIndexes(java.lang.String selectLocator,
                          java.lang.String variableName)
Parameters:
selectLocator - an element locator identifying a drop-down menu
variableName - The variable name to store this value to
See Also:
getSelectedIndexes(java.lang.String)

getSelectedIndex

java.lang.String getSelectedIndex(java.lang.String selectLocator)
Gets option index (option number, starting at 0) for selected option in the specified select element.

Parameters:
selectLocator - an element locator identifying a drop-down menu
Returns:
the option index

verifySelectedIndex

void verifySelectedIndex(java.lang.String selectLocator,
                         java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIndex(java.lang.String)

assertSelectedIndex

void assertSelectedIndex(java.lang.String selectLocator,
                         java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIndex(java.lang.String)

verifyNotSelectedIndex

void verifyNotSelectedIndex(java.lang.String selectLocator,
                            java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIndex(java.lang.String)

assertNotSelectedIndex

void assertNotSelectedIndex(java.lang.String selectLocator,
                            java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIndex(java.lang.String)

waitForSelectedIndex

void waitForSelectedIndex(java.lang.String selectLocator,
                          java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIndex(java.lang.String)

waitForNotSelectedIndex

void waitForNotSelectedIndex(java.lang.String selectLocator,
                             java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIndex(java.lang.String)

storeSelectedIndex

void storeSelectedIndex(java.lang.String selectLocator,
                        java.lang.String variableName)
Parameters:
selectLocator - an element locator identifying a drop-down menu
variableName - The variable name to store this value to
See Also:
getSelectedIndex(java.lang.String)

getSelectedIds

java.lang.String[] getSelectedIds(java.lang.String selectLocator)
Gets all option element IDs for selected options in the specified select or multi-select element.

Parameters:
selectLocator - an element locator identifying a drop-down menu
Returns:
the selected Ids

verifySelectedIds

void verifySelectedIds(java.lang.String selectLocator,
                       java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIds(java.lang.String)

assertSelectedIds

void assertSelectedIds(java.lang.String selectLocator,
                       java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIds(java.lang.String)

verifyNotSelectedIds

void verifyNotSelectedIds(java.lang.String selectLocator,
                          java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIds(java.lang.String)

assertNotSelectedIds

void assertNotSelectedIds(java.lang.String selectLocator,
                          java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIds(java.lang.String)

waitForSelectedIds

void waitForSelectedIds(java.lang.String selectLocator,
                        java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIds(java.lang.String)

waitForNotSelectedIds

void waitForNotSelectedIds(java.lang.String selectLocator,
                           java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedIds(java.lang.String)

storeSelectedIds

void storeSelectedIds(java.lang.String selectLocator,
                      java.lang.String variableName)
Parameters:
selectLocator - an element locator identifying a drop-down menu
variableName - The variable name to store this value to
See Also:
getSelectedIds(java.lang.String)

getSelectedId

java.lang.String getSelectedId(java.lang.String selectLocator)
Gets option element ID for selected option in the specified select element.

Parameters:
selectLocator - an element locator identifying a drop-down menu
Returns:
the selected id

verifySelectedId

void verifySelectedId(java.lang.String selectLocator,
                      java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedId(java.lang.String)

assertSelectedId

void assertSelectedId(java.lang.String selectLocator,
                      java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedId(java.lang.String)

verifyNotSelectedId

void verifyNotSelectedId(java.lang.String selectLocator,
                         java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedId(java.lang.String)

assertNotSelectedId

void assertNotSelectedId(java.lang.String selectLocator,
                         java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedId(java.lang.String)

waitForSelectedId

void waitForSelectedId(java.lang.String selectLocator,
                       java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedId(java.lang.String)

waitForNotSelectedId

void waitForNotSelectedId(java.lang.String selectLocator,
                          java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectedId(java.lang.String)

storeSelectedId

void storeSelectedId(java.lang.String selectLocator,
                     java.lang.String variableName)
Parameters:
selectLocator - an element locator identifying a drop-down menu
variableName - The variable name to store this value to
See Also:
getSelectedId(java.lang.String)

isSomethingSelected

boolean isSomethingSelected(java.lang.String selectLocator)
Determines whether some option in a drop-down menu is selected.

Parameters:
selectLocator - an element locator identifying a drop-down menu
Returns:
true if something was selected, false otherwise

verifySomethingSelected

void verifySomethingSelected(java.lang.String selectLocator)
Parameters:
selectLocator - an element locator identifying a drop-down menu
See Also:
isSomethingSelected(java.lang.String)

assertSomethingSelected

void assertSomethingSelected(java.lang.String selectLocator)
Parameters:
selectLocator - an element locator identifying a drop-down menu
See Also:
isSomethingSelected(java.lang.String)

verifyNotSomethingSelected

void verifyNotSomethingSelected(java.lang.String selectLocator)
Parameters:
selectLocator - an element locator identifying a drop-down menu
See Also:
isSomethingSelected(java.lang.String)

assertNotSomethingSelected

void assertNotSomethingSelected(java.lang.String selectLocator)
Parameters:
selectLocator - an element locator identifying a drop-down menu
See Also:
isSomethingSelected(java.lang.String)

waitForSomethingSelected

void waitForSomethingSelected(java.lang.String selectLocator)
Parameters:
selectLocator - an element locator identifying a drop-down menu
See Also:
isSomethingSelected(java.lang.String)

waitForNotSomethingSelected

void waitForNotSomethingSelected(java.lang.String selectLocator)
Parameters:
selectLocator - an element locator identifying a drop-down menu
See Also:
isSomethingSelected(java.lang.String)

storeSomethingSelected

void storeSomethingSelected(java.lang.String selectLocator,
                            java.lang.String variableName)
Parameters:
selectLocator - an element locator identifying a drop-down menu
variableName - The variable name to store this value to
See Also:
isSomethingSelected(java.lang.String)

getSelectOptions

java.lang.String[] getSelectOptions(java.lang.String selectLocator)
Gets all option labels in the specified select drop-down.

Parameters:
selectLocator - an element locator identifying a drop-down menu
Returns:
the selected options

verifySelectOptions

void verifySelectOptions(java.lang.String selectLocator,
                         java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectOptions(java.lang.String)

assertSelectOptions

void assertSelectOptions(java.lang.String selectLocator,
                         java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectOptions(java.lang.String)

verifyNotSelectOptions

void verifyNotSelectOptions(java.lang.String selectLocator,
                            java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectOptions(java.lang.String)

assertNotSelectOptions

void assertNotSelectOptions(java.lang.String selectLocator,
                            java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectOptions(java.lang.String)

waitForSelectOptions

void waitForSelectOptions(java.lang.String selectLocator,
                          java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectOptions(java.lang.String)

waitForNotSelectOptions

void waitForNotSelectOptions(java.lang.String selectLocator,
                             java.lang.String pattern)
Parameters:
selectLocator - an element locator identifying a drop-down menu
pattern - The pattern to check
See Also:
getSelectOptions(java.lang.String)

storeSelectOptions

void storeSelectOptions(java.lang.String selectLocator,
                        java.lang.String variableName)
Parameters:
selectLocator - an element locator identifying a drop-down menu
variableName - The variable name to store this value to
See Also:
getSelectOptions(java.lang.String)

getAttribute

java.lang.String getAttribute(java.lang.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:
attributeLocator - an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar"
Returns:
the attribute

verifyAttribute

void verifyAttribute(java.lang.String attributeLocator,
                     java.lang.String pattern)
Parameters:
attributeLocator - an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar"
pattern - The pattern to check
See Also:
getAttribute(java.lang.String)

assertAttribute

void assertAttribute(java.lang.String attributeLocator,
                     java.lang.String pattern)
Parameters:
attributeLocator - an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar"
pattern - The pattern to check
See Also:
getAttribute(java.lang.String)

verifyNotAttribute

void verifyNotAttribute(java.lang.String attributeLocator,
                        java.lang.String pattern)
Parameters:
attributeLocator - an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar"
pattern - The pattern to check
See Also:
getAttribute(java.lang.String)

assertNotAttribute

void assertNotAttribute(java.lang.String attributeLocator,
                        java.lang.String pattern)
Parameters:
attributeLocator - an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar"
pattern - The pattern to check
See Also:
getAttribute(java.lang.String)

waitForAttribute

void waitForAttribute(java.lang.String attributeLocator,
                      java.lang.String pattern)
Parameters:
attributeLocator - an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar"
pattern - The pattern to check
See Also:
getAttribute(java.lang.String)

waitForNotAttribute

void waitForNotAttribute(java.lang.String attributeLocator,
                         java.lang.String pattern)
Parameters:
attributeLocator - an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar"
pattern - The pattern to check
See Also:
getAttribute(java.lang.String)

storeAttribute

void storeAttribute(java.lang.String attributeLocator,
                    java.lang.String variableName)
Parameters:
attributeLocator - an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar"
variableName - The variable name to store this value to
See Also:
getAttribute(java.lang.String)

isTextPresent

boolean isTextPresent(java.lang.String pattern)
Verifies that the specified text pattern appears somewhere on the rendered page shown to the user.

Parameters:
pattern - a pattern to match with the text of the page
Returns:
true if the text pattern is present, false otherwise.

verifyTextPresent

void verifyTextPresent(java.lang.String pattern)
Parameters:
pattern - a pattern to match with the text of the page
See Also:
isTextPresent(java.lang.String)

assertTextPresent

void assertTextPresent(java.lang.String pattern)
Parameters:
pattern - a pattern to match with the text of the page
See Also:
isTextPresent(java.lang.String)

verifyNotTextPresent

void verifyNotTextPresent(java.lang.String pattern)
Parameters:
pattern - a pattern to match with the text of the page
See Also:
isTextPresent(java.lang.String)

verifyTextNotPresent

void verifyTextNotPresent(java.lang.String pattern)
Parameters:
pattern - a pattern to match with the text of the page
See Also:
isTextPresent(java.lang.String)

assertNotTextPresent

void assertNotTextPresent(java.lang.String pattern)
Parameters:
pattern - a pattern to match with the text of the page
See Also:
isTextPresent(java.lang.String)

assertTextNotPresent

void assertTextNotPresent(java.lang.String pattern)
Parameters:
pattern - a pattern to match with the text of the page
See Also:
isTextPresent(java.lang.String)

waitForTextPresent

void waitForTextPresent(java.lang.String pattern)
Parameters:
pattern - a pattern to match with the text of the page
See Also:
isTextPresent(java.lang.String)

waitForNotTextPresent

void waitForNotTextPresent(java.lang.String pattern)
Parameters:
pattern - a pattern to match with the text of the page
See Also:
isTextPresent(java.lang.String)

waitForTextNotPresent

void waitForTextNotPresent(java.lang.String pattern)
Parameters:
pattern - a pattern to match with the text of the page
See Also:
isTextPresent(java.lang.String)

storeTextPresent

void storeTextPresent(java.lang.String pattern,
                      java.lang.String variableName)
Parameters:
pattern - a pattern to match with the text of the page
variableName - The variable name to store this value to
See Also:
isTextPresent(java.lang.String)

isElementPresent

boolean isElementPresent(java.lang.String locator)
Verifies that the specified element is somewhere on the page.

Parameters:
locator - an element locator
Returns:
true if the element is present, false otherwise

verifyElementPresent

void verifyElementPresent(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isElementPresent(java.lang.String)

assertElementPresent

void assertElementPresent(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isElementPresent(java.lang.String)

verifyNotElementPresent

void verifyNotElementPresent(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isElementPresent(java.lang.String)

verifyElementNotPresent

void verifyElementNotPresent(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isElementPresent(java.lang.String)

assertNotElementPresent

void assertNotElementPresent(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isElementPresent(java.lang.String)

assertElementNotPresent

void assertElementNotPresent(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isElementPresent(java.lang.String)

waitForElementPresent

void waitForElementPresent(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isElementPresent(java.lang.String)

waitForNotElementPresent

void waitForNotElementPresent(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isElementPresent(java.lang.String)

waitForElementNotPresent

void waitForElementNotPresent(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isElementPresent(java.lang.String)

storeElementPresent

void storeElementPresent(java.lang.String locator,
                         java.lang.String variableName)
Parameters:
locator - an element locator
variableName - The variable name to store this value to
See Also:
isElementPresent(java.lang.String)

isVisible

boolean isVisible(java.lang.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:
locator - an element locator
Returns:
true if the element is visible, false otherwise

verifyVisible

void verifyVisible(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isVisible(java.lang.String)

assertVisible

void assertVisible(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isVisible(java.lang.String)

verifyNotVisible

void verifyNotVisible(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isVisible(java.lang.String)

assertNotVisible

void assertNotVisible(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isVisible(java.lang.String)

waitForVisible

void waitForVisible(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isVisible(java.lang.String)

waitForNotVisible

void waitForNotVisible(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isVisible(java.lang.String)

storeVisible

void storeVisible(java.lang.String locator,
                  java.lang.String variableName)
Parameters:
locator - an element locator
variableName - The variable name to store this value to
See Also:
isVisible(java.lang.String)

isEditable

boolean isEditable(java.lang.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:
locator - an element locator
Returns:
true if the element is editable, false otherwise

verifyEditable

void verifyEditable(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isEditable(java.lang.String)

assertEditable

void assertEditable(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isEditable(java.lang.String)

verifyNotEditable

void verifyNotEditable(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isEditable(java.lang.String)

assertNotEditable

void assertNotEditable(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isEditable(java.lang.String)

waitForEditable

void waitForEditable(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isEditable(java.lang.String)

waitForNotEditable

void waitForNotEditable(java.lang.String locator)
Parameters:
locator - an element locator
See Also:
isEditable(java.lang.String)

storeEditable

void storeEditable(java.lang.String locator,
                   java.lang.String variableName)
Parameters:
locator - an element locator
variableName - The variable name to store this value to
See Also:
isEditable(java.lang.String)

getAllButtons

java.lang.String[] getAllButtons()
Returns the IDs of all buttons on the page.

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

Returns:
the ids of all the buttons on the page

verifyAllButtons

void verifyAllButtons(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllButtons()

assertAllButtons

void assertAllButtons(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllButtons()

verifyNotAllButtons

void verifyNotAllButtons(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllButtons()

assertNotAllButtons

void assertNotAllButtons(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllButtons()

waitForAllButtons

void waitForAllButtons(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllButtons()

waitForNotAllButtons

void waitForNotAllButtons(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllButtons()

getAllLinks

java.lang.String[] getAllLinks()
Returns the IDs of all links on the page.

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

Returns:
all the ids of the links on the page

verifyAllLinks

void verifyAllLinks(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllLinks()

assertAllLinks

void assertAllLinks(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllLinks()

verifyNotAllLinks

void verifyNotAllLinks(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllLinks()

assertNotAllLinks

void assertNotAllLinks(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllLinks()

waitForAllLinks

void waitForAllLinks(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllLinks()

waitForNotAllLinks

void waitForNotAllLinks(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllLinks()

getAllFields

java.lang.String[] getAllFields()
Returns the IDs of all input fields on the page.

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

Returns:
the ids of all the input fields on the page

verifyAllFields

void verifyAllFields(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllFields()

assertAllFields

void assertAllFields(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllFields()

verifyNotAllFields

void verifyNotAllFields(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllFields()

assertNotAllFields

void assertNotAllFields(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllFields()

waitForAllFields

void waitForAllFields(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllFields()

waitForNotAllFields

void waitForNotAllFields(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllFields()

getAttributeFromAllWindows

java.lang.String[] getAttributeFromAllWindows(java.lang.String attributeName)
Returns every instance of some attribute from all known windows.

Parameters:
attributeName - name of an attribute on the windows
Returns:
every instance of some attribute from all known windows.

verifyAttributeFromAllWindows

void verifyAttributeFromAllWindows(java.lang.String attributeName,
                                   java.lang.String pattern)
Parameters:
attributeName - name of an attribute on the windows
pattern - The pattern to check
See Also:
getAttributeFromAllWindows(java.lang.String)

assertAttributeFromAllWindows

void assertAttributeFromAllWindows(java.lang.String attributeName,
                                   java.lang.String pattern)
Parameters:
attributeName - name of an attribute on the windows
pattern - The pattern to check
See Also:
getAttributeFromAllWindows(java.lang.String)

verifyNotAttributeFromAllWindows

void verifyNotAttributeFromAllWindows(java.lang.String attributeName,
                                      java.lang.String pattern)
Parameters:
attributeName - name of an attribute on the windows
pattern - The pattern to check
See Also:
getAttributeFromAllWindows(java.lang.String)

assertNotAttributeFromAllWindows

void assertNotAttributeFromAllWindows(java.lang.String attributeName,
                                      java.lang.String pattern)
Parameters:
attributeName - name of an attribute on the windows
pattern - The pattern to check
See Also:
getAttributeFromAllWindows(java.lang.String)

waitForAttributeFromAllWindows

void waitForAttributeFromAllWindows(java.lang.String attributeName,
                                    java.lang.String pattern)
Parameters:
attributeName - name of an attribute on the windows
pattern - The pattern to check
See Also:
getAttributeFromAllWindows(java.lang.String)

waitForNotAttributeFromAllWindows

void waitForNotAttributeFromAllWindows(java.lang.String attributeName,
                                       java.lang.String pattern)
Parameters:
attributeName - name of an attribute on the windows
pattern - The pattern to check
See Also:
getAttributeFromAllWindows(java.lang.String)

storeAttributeFromAllWindows

void storeAttributeFromAllWindows(java.lang.String attributeName,
                                  java.lang.String variableName)
Parameters:
attributeName - name of an attribute on the windows
variableName - The variable name to store this value to
See Also:
getAttributeFromAllWindows(java.lang.String)

dragdrop

void dragdrop(java.lang.String locator,
              java.lang.String movementsString)
deprecated - use dragAndDrop instead

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

dragdropAndWait

void dragdropAndWait(java.lang.String locator,
                     java.lang.String movementsString)
deprecated - use dragAndDrop instead

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

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

setMouseSpeed

void setMouseSpeed(java.lang.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:
pixels - the number of pixels between "mousemove" events

setMouseSpeedAndWait

void setMouseSpeedAndWait(java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
pixels - the number of pixels between "mousemove" events

dragAndDrop

void dragAndDrop(java.lang.String locator,
                 java.lang.String movementsString)
Drags an element a certain distance and then drops it

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

dragAndDropAndWait

void dragAndDropAndWait(java.lang.String locator,
                        java.lang.String movementsString)
Drags an element a certain distance and then drops it

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

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

dragAndDropToObject

void dragAndDropToObject(java.lang.String locatorOfObjectToBeDragged,
                         java.lang.String locatorOfDragDestinationObject)
Drags an element and drops it on another element

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

dragAndDropToObjectAndWait

void dragAndDropToObjectAndWait(java.lang.String locatorOfObjectToBeDragged,
                                java.lang.String locatorOfDragDestinationObject)
Drags an element and drops it on another element

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

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

windowFocus

void windowFocus()
Gives focus to the currently selected window


windowFocusAndWait

void windowFocusAndWait()
Gives focus to the currently selected window

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.


windowMaximize

void windowMaximize()
Resize currently selected window to take up the entire screen


windowMaximizeAndWait

void windowMaximizeAndWait()
Resize currently selected window to take up the entire screen

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.


getAllWindowNames

java.lang.String[] getAllWindowNames()
Returns the names of all windows that the browser knows about.

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

verifyAllWindowNames

void verifyAllWindowNames(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllWindowNames()

assertAllWindowNames

void assertAllWindowNames(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllWindowNames()

verifyNotAllWindowNames

void verifyNotAllWindowNames(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllWindowNames()

assertNotAllWindowNames

void assertNotAllWindowNames(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllWindowNames()

waitForAllWindowNames

void waitForAllWindowNames(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllWindowNames()

waitForNotAllWindowNames

void waitForNotAllWindowNames(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllWindowNames()

getAllWindowTitles

java.lang.String[] getAllWindowTitles()
Returns the titles of all windows that the browser knows about.

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

verifyAllWindowTitles

void verifyAllWindowTitles(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllWindowTitles()

assertAllWindowTitles

void assertAllWindowTitles(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllWindowTitles()

verifyNotAllWindowTitles

void verifyNotAllWindowTitles(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllWindowTitles()

assertNotAllWindowTitles

void assertNotAllWindowTitles(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllWindowTitles()

waitForAllWindowTitles

void waitForAllWindowTitles(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllWindowTitles()

waitForNotAllWindowTitles

void waitForNotAllWindowTitles(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getAllWindowTitles()

getHtmlSource

java.lang.String getHtmlSource()
Returns the entire HTML source between the opening and closing "html" tags.

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

verifyHtmlSource

void verifyHtmlSource(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getHtmlSource()

assertHtmlSource

void assertHtmlSource(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getHtmlSource()

verifyNotHtmlSource

void verifyNotHtmlSource(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getHtmlSource()

assertNotHtmlSource

void assertNotHtmlSource(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getHtmlSource()

waitForHtmlSource

void waitForHtmlSource(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getHtmlSource()

waitForNotHtmlSource

void waitForNotHtmlSource(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getHtmlSource()

storeHtmlSource

void storeHtmlSource(java.lang.String variableName)
Parameters:
variableName - The variable name to store this value to
See Also:
getHtmlSource()

setCursorPosition

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. This method will fail if the specified element isn't an input element or textarea.

Parameters:
locator - an element locator pointing to an input element or textarea
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.

setCursorPositionAndWait

void setCursorPositionAndWait(java.lang.String locator,
                              java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator pointing to an input element or textarea
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.

getElementIndex

java.lang.Number getElementIndex(java.lang.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:
locator - an element locator pointing to an element
Returns:
the relative index of an element to its parent (starting from 0)

verifyElementIndex

void verifyElementIndex(java.lang.String locator,
                        java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementIndex(java.lang.String)

assertElementIndex

void assertElementIndex(java.lang.String locator,
                        java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementIndex(java.lang.String)

verifyNotElementIndex

void verifyNotElementIndex(java.lang.String locator,
                           java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementIndex(java.lang.String)

assertNotElementIndex

void assertNotElementIndex(java.lang.String locator,
                           java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementIndex(java.lang.String)

waitForElementIndex

void waitForElementIndex(java.lang.String locator,
                         java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementIndex(java.lang.String)

waitForNotElementIndex

void waitForNotElementIndex(java.lang.String locator,
                            java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementIndex(java.lang.String)

storeElementIndex

void storeElementIndex(java.lang.String locator,
                       java.lang.String variableName)
Parameters:
locator - an element locator pointing to an element
variableName - The variable name to store this value to
See Also:
getElementIndex(java.lang.String)

isOrdered

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. Two same elements will not be considered ordered.

Parameters:
locator1 - an element locator pointing to the first element
locator2 - an element locator pointing to the second element
Returns:
true if the two elements haev the same parents and are ordered siblings in the DOM.

verifyOrdered

void verifyOrdered(java.lang.String locator1,
                   java.lang.String locator2)
Parameters:
locator1 - an element locator pointing to the first element
locator2 - an element locator pointing to the second element
See Also:
isOrdered(java.lang.String, java.lang.String)

assertOrdered

void assertOrdered(java.lang.String locator1,
                   java.lang.String locator2)
Parameters:
locator1 - an element locator pointing to the first element
locator2 - an element locator pointing to the second element
See Also:
isOrdered(java.lang.String, java.lang.String)

verifyNotOrdered

void verifyNotOrdered(java.lang.String locator1,
                      java.lang.String locator2)
Parameters:
locator1 - an element locator pointing to the first element
locator2 - an element locator pointing to the second element
See Also:
isOrdered(java.lang.String, java.lang.String)

assertNotOrdered

void assertNotOrdered(java.lang.String locator1,
                      java.lang.String locator2)
Parameters:
locator1 - an element locator pointing to the first element
locator2 - an element locator pointing to the second element
See Also:
isOrdered(java.lang.String, java.lang.String)

waitForOrdered

void waitForOrdered(java.lang.String locator1,
                    java.lang.String locator2)
Parameters:
locator1 - an element locator pointing to the first element
locator2 - an element locator pointing to the second element
See Also:
isOrdered(java.lang.String, java.lang.String)

waitForNotOrdered

void waitForNotOrdered(java.lang.String locator1,
                       java.lang.String locator2)
Parameters:
locator1 - an element locator pointing to the first element
locator2 - an element locator pointing to the second element
See Also:
isOrdered(java.lang.String, java.lang.String)

storeOrdered

void storeOrdered(java.lang.String locator1,
                  java.lang.String locator2,
                  java.lang.String variableName)
Parameters:
locator1 - an element locator pointing to the first element
locator2 - an element locator pointing to the second element
variableName - The variable name to store this value to
See Also:
isOrdered(java.lang.String, java.lang.String)

getElementPositionLeft

java.lang.Number getElementPositionLeft(java.lang.String locator)
Retrieves the horizontal position of an element

Parameters:
locator - an element locator pointing to an element OR an element itself
Returns:
the horizontal position of an element

verifyElementPositionLeft

void verifyElementPositionLeft(java.lang.String locator,
                               java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element OR an element itself
pattern - The pattern to check
See Also:
getElementPositionLeft(java.lang.String)

assertElementPositionLeft

void assertElementPositionLeft(java.lang.String locator,
                               java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element OR an element itself
pattern - The pattern to check
See Also:
getElementPositionLeft(java.lang.String)

verifyNotElementPositionLeft

void verifyNotElementPositionLeft(java.lang.String locator,
                                  java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element OR an element itself
pattern - The pattern to check
See Also:
getElementPositionLeft(java.lang.String)

assertNotElementPositionLeft

void assertNotElementPositionLeft(java.lang.String locator,
                                  java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element OR an element itself
pattern - The pattern to check
See Also:
getElementPositionLeft(java.lang.String)

waitForElementPositionLeft

void waitForElementPositionLeft(java.lang.String locator,
                                java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element OR an element itself
pattern - The pattern to check
See Also:
getElementPositionLeft(java.lang.String)

waitForNotElementPositionLeft

void waitForNotElementPositionLeft(java.lang.String locator,
                                   java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element OR an element itself
pattern - The pattern to check
See Also:
getElementPositionLeft(java.lang.String)

storeElementPositionLeft

void storeElementPositionLeft(java.lang.String locator,
                              java.lang.String variableName)
Parameters:
locator - an element locator pointing to an element OR an element itself
variableName - The variable name to store this value to
See Also:
getElementPositionLeft(java.lang.String)

getElementPositionTop

java.lang.Number getElementPositionTop(java.lang.String locator)
Retrieves the vertical position of an element

Parameters:
locator - an element locator pointing to an element OR an element itself
Returns:
the vertical position of an element

verifyElementPositionTop

void verifyElementPositionTop(java.lang.String locator,
                              java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element OR an element itself
pattern - The pattern to check
See Also:
getElementPositionTop(java.lang.String)

assertElementPositionTop

void assertElementPositionTop(java.lang.String locator,
                              java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element OR an element itself
pattern - The pattern to check
See Also:
getElementPositionTop(java.lang.String)

verifyNotElementPositionTop

void verifyNotElementPositionTop(java.lang.String locator,
                                 java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element OR an element itself
pattern - The pattern to check
See Also:
getElementPositionTop(java.lang.String)

assertNotElementPositionTop

void assertNotElementPositionTop(java.lang.String locator,
                                 java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element OR an element itself
pattern - The pattern to check
See Also:
getElementPositionTop(java.lang.String)

waitForElementPositionTop

void waitForElementPositionTop(java.lang.String locator,
                               java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element OR an element itself
pattern - The pattern to check
See Also:
getElementPositionTop(java.lang.String)

waitForNotElementPositionTop

void waitForNotElementPositionTop(java.lang.String locator,
                                  java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element OR an element itself
pattern - The pattern to check
See Also:
getElementPositionTop(java.lang.String)

storeElementPositionTop

void storeElementPositionTop(java.lang.String locator,
                             java.lang.String variableName)
Parameters:
locator - an element locator pointing to an element OR an element itself
variableName - The variable name to store this value to
See Also:
getElementPositionTop(java.lang.String)

getElementWidth

java.lang.Number getElementWidth(java.lang.String locator)
Retrieves the width of an element

Parameters:
locator - an element locator pointing to an element
Returns:
the width of an element

verifyElementWidth

void verifyElementWidth(java.lang.String locator,
                        java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementWidth(java.lang.String)

assertElementWidth

void assertElementWidth(java.lang.String locator,
                        java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementWidth(java.lang.String)

verifyNotElementWidth

void verifyNotElementWidth(java.lang.String locator,
                           java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementWidth(java.lang.String)

assertNotElementWidth

void assertNotElementWidth(java.lang.String locator,
                           java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementWidth(java.lang.String)

waitForElementWidth

void waitForElementWidth(java.lang.String locator,
                         java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementWidth(java.lang.String)

waitForNotElementWidth

void waitForNotElementWidth(java.lang.String locator,
                            java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementWidth(java.lang.String)

storeElementWidth

void storeElementWidth(java.lang.String locator,
                       java.lang.String variableName)
Parameters:
locator - an element locator pointing to an element
variableName - The variable name to store this value to
See Also:
getElementWidth(java.lang.String)

getElementHeight

java.lang.Number getElementHeight(java.lang.String locator)
Retrieves the height of an element

Parameters:
locator - an element locator pointing to an element
Returns:
the element's height

verifyElementHeight

void verifyElementHeight(java.lang.String locator,
                         java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementHeight(java.lang.String)

assertElementHeight

void assertElementHeight(java.lang.String locator,
                         java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementHeight(java.lang.String)

verifyNotElementHeight

void verifyNotElementHeight(java.lang.String locator,
                            java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementHeight(java.lang.String)

assertNotElementHeight

void assertNotElementHeight(java.lang.String locator,
                            java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementHeight(java.lang.String)

waitForElementHeight

void waitForElementHeight(java.lang.String locator,
                          java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementHeight(java.lang.String)

waitForNotElementHeight

void waitForNotElementHeight(java.lang.String locator,
                             java.lang.String pattern)
Parameters:
locator - an element locator pointing to an element
pattern - The pattern to check
See Also:
getElementHeight(java.lang.String)

storeElementHeight

void storeElementHeight(java.lang.String locator,
                        java.lang.String variableName)
Parameters:
locator - an element locator pointing to an element
variableName - The variable name to store this value to
See Also:
getElementHeight(java.lang.String)

getExpression

java.lang.String getExpression(java.lang.String expression)
Returns the specified expression.

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

NOTE: We don't support expressions like "javascript{new Date().getTime()}" for implementation reasons.

Parameters:
expression - the value to return
Returns:
the specified expression.

verifyExpression

void verifyExpression(java.lang.String expression,
                      java.lang.String pattern)
Parameters:
expression - the value to return
pattern - The pattern to check
See Also:
getExpression(java.lang.String)

assertExpression

void assertExpression(java.lang.String expression,
                      java.lang.String pattern)
Parameters:
expression - the value to return
pattern - The pattern to check
See Also:
getExpression(java.lang.String)

verifyNotExpression

void verifyNotExpression(java.lang.String expression,
                         java.lang.String pattern)
Parameters:
expression - the value to return
pattern - The pattern to check
See Also:
getExpression(java.lang.String)

assertNotExpression

void assertNotExpression(java.lang.String expression,
                         java.lang.String pattern)
Parameters:
expression - the value to return
pattern - The pattern to check
See Also:
getExpression(java.lang.String)

waitForExpression

void waitForExpression(java.lang.String expression,
                       java.lang.String pattern)
Parameters:
expression - the value to return
pattern - The pattern to check
See Also:
getExpression(java.lang.String)

waitForNotExpression

void waitForNotExpression(java.lang.String expression,
                          java.lang.String pattern)
Parameters:
expression - the value to return
pattern - The pattern to check
See Also:
getExpression(java.lang.String)

storeExpression

void storeExpression(java.lang.String expression,
                     java.lang.String variableName)
NOTE: We don't support expressions like "javascript{new Date().getTime()}" for implementation reasons.

Parameters:
expression - the value to return
variableName - The variable name to store this value to
See Also:
getExpression(java.lang.String)

getXpathCount

java.lang.Number getXpathCount(java.lang.String xpath)
Returns the number of nodes that match the specified xpath, eg. "//table" would give the number of tables.

Parameters:
xpath - the xpath expression to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.
Returns:
the number of nodes that match the specified xpath

verifyXpathCount

void verifyXpathCount(java.lang.String xpath,
                      java.lang.String pattern)
Parameters:
xpath - the xpath expression to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.
pattern - The pattern to check
See Also:
getXpathCount(java.lang.String)

assertXpathCount

void assertXpathCount(java.lang.String xpath,
                      java.lang.String pattern)
Parameters:
xpath - the xpath expression to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.
pattern - The pattern to check
See Also:
getXpathCount(java.lang.String)

verifyNotXpathCount

void verifyNotXpathCount(java.lang.String xpath,
                         java.lang.String pattern)
Parameters:
xpath - the xpath expression to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.
pattern - The pattern to check
See Also:
getXpathCount(java.lang.String)

assertNotXpathCount

void assertNotXpathCount(java.lang.String xpath,
                         java.lang.String pattern)
Parameters:
xpath - the xpath expression to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.
pattern - The pattern to check
See Also:
getXpathCount(java.lang.String)

waitForXpathCount

void waitForXpathCount(java.lang.String xpath,
                       java.lang.String pattern)
Parameters:
xpath - the xpath expression to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.
pattern - The pattern to check
See Also:
getXpathCount(java.lang.String)

waitForNotXpathCount

void waitForNotXpathCount(java.lang.String xpath,
                          java.lang.String pattern)
Parameters:
xpath - the xpath expression to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.
pattern - The pattern to check
See Also:
getXpathCount(java.lang.String)

storeXpathCount

void storeXpathCount(java.lang.String xpath,
                     java.lang.String variableName)
Parameters:
xpath - the xpath expression to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.
variableName - The variable name to store this value to
See Also:
getXpathCount(java.lang.String)

assignId

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. This ID will disappear once the page is reloaded.

Parameters:
locator - an element locator pointing to an element
identifier - a string to be used as the ID of the specified element

assignIdAndWait

void assignIdAndWait(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. This ID will disappear once the page is reloaded.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
locator - an element locator pointing to an element
identifier - a string to be used as the ID of the specified element

ignoreAttributesWithoutValueAndWait

void ignoreAttributesWithoutValueAndWait(java.lang.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").

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
ignore - boolean, true means we'll ignore attributes without value at the expense of xpath "correctness"; false means we'll sacrifice speed for correctness.

waitForCondition

void waitForCondition(java.lang.String script,
                      java.lang.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.

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

Parameters:
script - the JavaScript snippet to run
timeout - a timeout in milliseconds, after which this command will return with an error

waitForConditionAndWait

void waitForConditionAndWait(java.lang.String script,
                             java.lang.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.

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

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
script - the JavaScript snippet to run
timeout - a timeout in milliseconds, after which this command will return with an error

setTimeout

void setTimeout(java.lang.String timeout)
Specifies the amount of time that Selenium will wait for actions to complete.

Actions that require waiting include the "waitFor*" actions. The timeout for the connection/sockets will be double the input timeout. The default timeout is 30 seconds.

Parameters:
timeout - a timeout in milliseconds, after which the action will return with an error

waitForPageToLoad

void waitForPageToLoad(java.lang.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:
timeout - a timeout in milliseconds, after which this command will return with an error

waitForPageToLoadAndWait

void waitForPageToLoadAndWait(java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
timeout - a timeout in milliseconds, after which this command will return with an error

waitForFrameToLoad

void waitForFrameToLoad(java.lang.String frameAddress,
                        java.lang.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:
frameAddress - FrameAddress from the server side
timeout - a timeout in milliseconds, after which this command will return with an error

waitForFrameToLoadAndWait

void waitForFrameToLoadAndWait(java.lang.String frameAddress,
                               java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
frameAddress - FrameAddress from the server side
timeout - a timeout in milliseconds, after which this command will return with an error

getCookie

java.lang.String getCookie()
Return all cookies of the current page under test.

Returns:
all cookies of the current page

verifyCookie

void verifyCookie(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getCookie()

assertCookie

void assertCookie(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getCookie()

verifyNotCookie

void verifyNotCookie(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getCookie()

assertNotCookie

void assertNotCookie(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getCookie()

waitForCookie

void waitForCookie(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getCookie()

waitForNotCookie

void waitForNotCookie(java.lang.String pattern)
Parameters:
pattern - The pattern to check
See Also:
getCookie()

storeCookie

void storeCookie(java.lang.String variableName)
Parameters:
variableName - The variable name to store this value to
See Also:
getCookie()

getCookieByName

java.lang.String getCookieByName(java.lang.String name)
Returns the value of the cookie with the specified name, or throws an error if the cookie is not present.

Parameters:
name - the name of the cookie
Returns:
the cookie

verifyCookieByName

void verifyCookieByName(java.lang.String name,
                        java.lang.String pattern)
Parameters:
name - the name of the cookie
pattern - The pattern to check
See Also:
getCookieByName(java.lang.String)

assertCookieByName

void assertCookieByName(java.lang.String name,
                        java.lang.String pattern)
Parameters:
name - the name of the cookie
pattern - The pattern to check
See Also:
getCookieByName(java.lang.String)

verifyNotCookieByName

void verifyNotCookieByName(java.lang.String name,
                           java.lang.String pattern)
Parameters:
name - the name of the cookie
pattern - The pattern to check
See Also:
getCookieByName(java.lang.String)

assertNotCookieByName

void assertNotCookieByName(java.lang.String name,
                           java.lang.String pattern)
Parameters:
name - the name of the cookie
pattern - The pattern to check
See Also:
getCookieByName(java.lang.String)

waitForCookieByName

void waitForCookieByName(java.lang.String name,
                         java.lang.String pattern)
Parameters:
name - the name of the cookie
pattern - The pattern to check
See Also:
getCookieByName(java.lang.String)

waitForNotCookieByName

void waitForNotCookieByName(java.lang.String name,
                            java.lang.String pattern)
Parameters:
name - the name of the cookie
pattern - The pattern to check
See Also:
getCookieByName(java.lang.String)

storeCookieByName

void storeCookieByName(java.lang.String name,
                       java.lang.String variableName)
Parameters:
name - the name of the cookie
variableName - The variable name to store this value to
See Also:
getCookieByName(java.lang.String)

isCookiePresent

boolean isCookiePresent(java.lang.String name)
Returns true if a cookie with the specified name is present, or false otherwise.

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

verifyCookiePresent

void verifyCookiePresent(java.lang.String name)
Parameters:
name - the name of the cookie
See Also:
isCookiePresent(java.lang.String)

assertCookiePresent

void assertCookiePresent(java.lang.String name)
Parameters:
name - the name of the cookie
See Also:
isCookiePresent(java.lang.String)

verifyNotCookiePresent

void verifyNotCookiePresent(java.lang.String name)
Parameters:
name - the name of the cookie
See Also:
isCookiePresent(java.lang.String)

verifyCookieNotPresent

void verifyCookieNotPresent(java.lang.String name)
Parameters:
name - the name of the cookie
See Also:
isCookiePresent(java.lang.String)

assertNotCookiePresent

void assertNotCookiePresent(java.lang.String name)
Parameters:
name - the name of the cookie
See Also:
isCookiePresent(java.lang.String)

assertCookieNotPresent

void assertCookieNotPresent(java.lang.String name)
Parameters:
name - the name of the cookie
See Also:
isCookiePresent(java.lang.String)

waitForCookiePresent

void waitForCookiePresent(java.lang.String name)
Parameters:
name - the name of the cookie
See Also:
isCookiePresent(java.lang.String)

waitForCookieNotPresent

void waitForCookieNotPresent(java.lang.String name)
Parameters:
name - the name of the cookie
See Also:
isCookiePresent(java.lang.String)

waitForNotCookiePresent

void waitForNotCookiePresent(java.lang.String name)
Parameters:
name - the name of the cookie
See Also:
isCookiePresent(java.lang.String)

storeCookiePresent

void storeCookiePresent(java.lang.String name,
                        java.lang.String variableName)
Parameters:
name - the name of the cookie
variableName - The variable name to store this value to
See Also:
isCookiePresent(java.lang.String)

createCookie

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.

Parameters:
nameValuePair - name and value of the cookie in a format "name=value"
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.

createCookieAndWait

void createCookieAndWait(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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
nameValuePair - name and value of the cookie in a format "name=value"
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.

deleteCookie

void deleteCookie(java.lang.String name,
                  java.lang.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:
name - the name of the cookie to be deleted
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.

deleteCookieAndWait

void deleteCookieAndWait(java.lang.String name,
                         java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
name - the name of the cookie to be deleted
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.

deleteAllVisibleCookies

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.


deleteAllVisibleCookiesAndWait

void deleteAllVisibleCookiesAndWait()
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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.


setBrowserLogLevel

void setBrowserLogLevel(java.lang.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:
logLevel - one of the following: "debug", "info", "warn", "error" or "off"

setBrowserLogLevelAndWait

void setBrowserLogLevelAndWait(java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
logLevel - one of the following: "debug", "info", "warn", "error" or "off"

runScript

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. 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:
script - the JavaScript snippet to run

runScriptAndWait

void runScriptAndWait(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. 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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
script - the JavaScript snippet to run

addLocationStrategy

void addLocationStrategy(java.lang.String strategyName,
                         java.lang.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: The function must return null if the element can't be found.

Parameters:
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);

addLocationStrategyAndWait

void addLocationStrategyAndWait(java.lang.String strategyName,
                                java.lang.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: The function must return null if the element can't be found.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
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);

rollup

void rollup(java.lang.String rollupName,
            java.lang.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:
rollupName - the name of the rollup command
kwargs - keyword arguments string that influences how the rollup expands into commands

rollupAndWait

void rollupAndWait(java.lang.String rollupName,
                   java.lang.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.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
rollupName - the name of the rollup command
kwargs - keyword arguments string that influences how the rollup expands into commands

removeScript

void removeScript(java.lang.String scriptTagId)
Removes a script tag from the Selenium document identified by the given id. Does nothing if the referenced tag doesn't exist.

Parameters:
scriptTagId - the id of the script element to remove.

removeScriptAndWait

void removeScriptAndWait(java.lang.String scriptTagId)
Removes a script tag from the Selenium document identified by the given id. Does nothing if the referenced tag doesn't exist.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
scriptTagId - the id of the script element to remove.

useXpathLibrary

void useXpathLibrary(java.lang.String libraryName)
Allows choice of one of the available libraries.

Parameters:
libraryName - name of the desired library Only the following three can be chosen:
  • "ajaxslt" - Google's library
  • "javascript-xpath" - 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.

useXpathLibraryAndWait

void useXpathLibraryAndWait(java.lang.String libraryName)
Allows choice of one of the available libraries.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
libraryName - name of the desired library Only the following three can be chosen:
  • "ajaxslt" - Google's library
  • "javascript-xpath" - 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.

pause

void pause(java.lang.String waitTime)
Wait for the specified amount of time (in milliseconds)

Parameters:
waitTime - the amount of time to sleep (in milliseconds)

pauseAndWait

void pauseAndWait(java.lang.String waitTime)
Wait for the specified amount of time (in milliseconds)

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
waitTime - the amount of time to sleep (in milliseconds)

store

void store(java.lang.String expression,
           java.lang.String variableName)
This command is a synonym for storeExpression.

Parameters:
expression - the value to store
variableName - the name of a variable in which the result is to be stored.

assertSelected

void assertSelected(java.lang.String selectLocator,
                    java.lang.String optionLocator)
Verifies that the selected option of a drop-down satisfies the optionSpecifier. Note that this command is deprecated; you should use assertSelectedLabel, assertSelectedValue, assertSelectedIndex, or assertSelectedId instead.

See the select command for more information about option locators.

Parameters:
selectLocator - an element locator identifying a drop-down menu
optionLocator - an option locator, typically just an option label (e.g. "John Smith")

assertSelectedAndWait

void assertSelectedAndWait(java.lang.String selectLocator,
                           java.lang.String optionLocator)
Verifies that the selected option of a drop-down satisfies the optionSpecifier. Note that this command is deprecated; you should use assertSelectedLabel, assertSelectedValue, assertSelectedIndex, or assertSelectedId instead.

See the select command for more information about option locators.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
selectLocator - an element locator identifying a drop-down menu
optionLocator - an option locator, typically just an option label (e.g. "John Smith")

assertFailureOnNext

void assertFailureOnNext(java.lang.String message)
Tell Selenium to expect a failure on the next command execution.

Parameters:
message - The failure message we should expect. This command will fail if the wrong failure message appears.

assertFailureOnNextAndWait

void assertFailureOnNextAndWait(java.lang.String message)
Tell Selenium to expect a failure on the next command execution.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
message - The failure message we should expect. This command will fail if the wrong failure message appears.

assertErrorOnNext

void assertErrorOnNext(java.lang.String message)
Tell Selenium to expect an error on the next command execution.

Parameters:
message - The error message we should expect. This command will fail if the wrong error message appears.

assertErrorOnNextAndWait

void assertErrorOnNextAndWait(java.lang.String message)
Tell Selenium to expect an error on the next command execution.

Note: This command assumes that it causes a page to load and, in turn, waits for it to complete loading before returning.

Parameters:
message - The error message we should expect. This command will fail if the wrong error message appears.

flash

SeleniumFlash flash(java.lang.String id)
Returns a flash-selenium object that allows for easier control over ExternalInterface enabled flash objects. The embed must have an id attribute in order for this method to work.

Parameters:
id - the id attribute of the flash embed object
Returns:
the flash selenium object

getWebDriver

WebDriver getWebDriver()
Return the underlying WebDriver instance.

Returns:
the web driver

Copyright © 2014 Neustar, Inc. All Rights Reserved.