+ * Element Locators tell Selenium which HTML element a command refers to. + * The format of a locator is:
+ *+ * locatorType=argument + *+ * + *
+ * We support the following strategies for locating elements: + *
+ *+ *+ *+ *
+ *- identifier=id
+ *- Select the element with the specified @id attribute. If no match is + * found, select the first element whose @name attribute is id. + * (This is normally the default; see below.)
+ *- id=id
+ *- Select the element with the specified @id attribute.
+ * + *- name=name
+ *- Select the first element with the specified @name attribute.
+ *- + *
+ *
+ *- username
+ *- name=username
+ *- The name may optionally be followed by one or more element-filters, separated from the name by whitespace. If the filterType is not specified, value is assumed.
+ * + *- + *
+ *
+ *- name=flavour value=chocolate
+ *- dom=javascriptExpression
+ * + *- + * + *
+ * + *- Find an element using JavaScript traversal of the HTML Document Object + * Model. DOM locators must begin with "document.". + *
+ * + *+ *
+ *- dom=document.forms['myForm'].myDropdown
+ *- dom=document.images[56]
+ *- xpath=xpathExpression
+ *- Locate an element using an XPath expression. + *
+ *+ *
+ *- xpath=//img[@alt='The image alt text']
+ *- xpath=//table[@id='table1']//tr[4]/td[2]
+ * + *- link=textPattern
+ *- Select the link (anchor) element which contains text matching the + * specified pattern. + *
+ *+ *
+ * + *- link=The link text
+ *
+ * Without an explicit locator prefix, Selenium uses the following default + * strategies: + *
+ * + *+ *+ * + *Element filters can be used with a locator to refine a list of candidate elements. They are currently used only in the 'name' element-locator.
+ *Filters look much like locators, ie.
+ *+ * filterType=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).+ *
+ * Various Pattern syntaxes are available for matching string values: + *
+ *+ *+ *+ *
+ *- glob:pattern
+ *- Match a string against a "glob" (aka "wildmat") pattern. "Glob" is a + * kind of limited regular-expression syntax typically used in command-line + * shells. In a glob pattern, "*" represents any sequence of characters, and "?" + * represents any single character. Glob patterns match against the entire + * string.
+ *- regexp:regexp
+ *- Match a string using a regular-expression. The full power of JavaScript + * regular-expressions is available.
+ *- exact:string
+ * + *- Match a string exactly, verbatim, without any of that fancy wildcard + * stuff.
+ *
+ * If no pattern prefix is specified, Selenium assumes that it's a "glob" + * pattern. + *
+ */ + this.browserbot = browserbot; + this.optionLocatorFactory = new OptionLocatorFactory(); + this.page = function() { + return browserbot.getCurrentPage(); + }; +} + +Selenium.createForFrame = function(frame) { + return new Selenium(BrowserBot.createForFrame(frame)); +}; + +Selenium.prototype.reset = function() { + /** + * Clear out all stored variables and select the null (starting) window + */ + storedVars = new Object(); + this.browserbot.selectWindow("null"); +}; + +Selenium.prototype.doClick = function(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. + * + * @param locator an element locator + * + */ + var element = this.page().findElement(locator); + this.page().clickElement(element); +}; + +Selenium.prototype.doFireEvent = function(locator, eventName) { + /** + * Explicitly simulate an event, to trigger the corresponding "onevent" + * handler. + * + * @param locator an element locator + * @param eventName the event name, e.g. "focus" or "blur" + */ + var element = this.page().findElement(locator); + triggerEvent(element, eventName, false); +}; + +Selenium.prototype.doKeyPress = function(locator, keycode) { + /** + * Simulates a user pressing and releasing a key. + * + * @param locator an element locator + * @param keycode the numeric keycode of the key to be pressed, normally the + * ASCII value of that key. + */ + var element = this.page().findElement(locator); + triggerKeyEvent(element, 'keypress', keycode, true); +}; + +Selenium.prototype.doKeyDown = function(locator, keycode) { + /** + * Simulates a user pressing a key (without releasing it yet). + * + * @param locator an element locator + * @param keycode the numeric keycode of the key to be pressed, normally the + * ASCII value of that key. + */ + var element = this.page().findElement(locator); + triggerKeyEvent(element, 'keydown', keycode, true); +}; + +Selenium.prototype.doKeyUp = function(locator, keycode) { + /** + * Simulates a user releasing a key. + * + * @param locator an element locator + * @param keycode the numeric keycode of the key to be released, normally the + * ASCII value of that key. + */ + var element = this.page().findElement(locator); + triggerKeyEvent(element, 'keyup', keycode, true); +}; + +Selenium.prototype.doMouseOver = function(locator) { + /** + * Simulates a user hovering a mouse over the specified element. + * + * @param locator an element locator + */ + var element = this.page().findElement(locator); + triggerMouseEvent(element, 'mouseover', true); +}; + +Selenium.prototype.doMouseDown = function(locator) { + /** + * Simulates a user pressing the mouse button (without releasing it yet) on + * the specified element. + * + * @param locator an element locator + */ + var element = this.page().findElement(locator); + triggerMouseEvent(element, 'mousedown', true); +}; + +Selenium.prototype.doType = function(locator, 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.
+ * + * @param locator an element locator + * @param value the value to type + */ + // TODO fail if it can't be typed into. + var element = this.page().findElement(locator); + this.page().replaceText(element, value); +}; + +Selenium.prototype.findToggleButton = function(locator) { + var element = this.page().findElement(locator); + if (element.checked == null) { + Assert.fail("Element " + locator + " is not a toggle-button."); + } + return element; +} + +Selenium.prototype.doCheck = function(locator) { + /** + * Check a toggle-button (checkbox/radio) + * + * @param locator an element locator + */ + this.findToggleButton(locator).checked = true; +}; + +Selenium.prototype.doUncheck = function(locator) { + /** + * Uncheck a toggle-button (checkbox/radio) + * + * @param locator an element locator + */ + this.findToggleButton(locator).checked = false; +}; + +Selenium.prototype.doSelect = function(selectLocator, 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. + *
+ * + * + * @param selectLocator an element locator identifying a drop-down menu + * @param optionLocator an option locator (a label by default) + */ + var element = this.page().findElement(selectLocator); + if (!("options" in element)) { + throw new SeleniumError("Specified element is not a Select (has no options)"); + } + var locator = this.optionLocatorFactory.fromLocatorString(optionLocator); + var option = locator.findOption(element); + this.page().selectOption(element, option); +}; + +Selenium.prototype.doAddSelection = function(locator, optionLocator) { + /** + * Add a selection to the set of selected options in a multi-select element using an option locator. + * + * @see #doSelect for details of option locators + * + * @param locator an element locator identifying a multi-select box + * @param optionLocator an option locator (a label by default) + */ + var element = this.page().findElement(locator); + if (!("options" in element)) { + throw new SeleniumError("Specified element is not a Select (has no options)"); + } + var locator = this.optionLocatorFactory.fromLocatorString(optionLocator); + var option = locator.findOption(element); + this.page().addSelection(element, option); +}; + +Selenium.prototype.doRemoveSelection = function(locator, optionLocator) { + /** + * Remove a selection from the set of selected options in a multi-select element using an option locator. + * + * @see #doSelect for details of option locators + * + * @param locator an element locator identifying a multi-select box + * @param optionLocator an option locator (a label by default) + */ + + var element = this.page().findElement(locator); + if (!("options" in element)) { + throw new SeleniumError("Specified element is not a Select (has no options)"); + } + var locator = this.optionLocatorFactory.fromLocatorString(optionLocator); + var option = locator.findOption(element); + this.page().removeSelection(element, option); +}; + +Selenium.prototype.doSubmit = function(formLocator) { + /** + * Submit the specified form. This is particularly useful for forms without + * submit buttons, e.g. single-input "Search" forms. + * + * @param formLocator an element locator for the form you want to submit + */ + var form = this.page().findElement(formLocator); + var actuallySubmit = true; + if (form.onsubmit) { + // apply this to the correct window so alerts are properly handled, even in IE HTA mode + actuallySubmit = form.onsubmit.apply(this.browserbot.getContentWindow()); + } + if (actuallySubmit) { + form.submit(); + } + +}; + +Selenium.prototype.doOpen = function(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. + * + * @param url the URL to open; may be relative or absolute + */ + this.browserbot.openLocation(url); + return SELENIUM_PROCESS_WAIT; +}; + +Selenium.prototype.doSelectWindow = function(windowID) { + /** + * Selects a popup window; once a popup window has been selected, all + * commands go to that window. To select the main window again, use "null" + * as the target. + * + * @param windowID the JavaScript window ID of the window to select + */ + this.browserbot.selectWindow(windowID); +}; + +Selenium.prototype.doWaitForPopUp = function(windowID, timeout) { + /** + * Waits for a popup window to appear and load up. + * + * @param windowID the JavaScript window ID of the window that will appear + * @param timeout a timeout in milliseconds, after which the action will return with an error + */ + if (isNaN(timeout)) { + throw new SeleniumError("Timeout is not a number: " + timeout); + } + + testLoop.waitForCondition = function () { + var targetWindow = selenium.browserbot.getTargetWindow(windowID); + if (!targetWindow) return false; + if (!targetWindow.location) return false; + if ("about:blank" == targetWindow.location) return false; + if (!targetWindow.document) return false; + if (!targetWindow.document.readyState) return true; + if ('complete' != targetWindow.document.readyState) return false; + return true; + }; + + testLoop.waitForConditionStart = new Date().getTime(); + testLoop.waitForConditionTimeout = timeout; + +} + +Selenium.prototype.doWaitForPopUp.dontCheckAlertsAndConfirms = true; + +Selenium.prototype.doChooseCancelOnNextConfirmation = function() { + /** + * 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. + * + */ + this.browserbot.cancelNextConfirmation(); +}; + + +Selenium.prototype.doAnswerOnNextPrompt = function(answer) { + /** + * Instructs Selenium to return the specified answer string in response to + * the next JavaScript prompt [window.prompt()]. + * + * + * @param answer the answer to give in response to the prompt pop-up + */ + this.browserbot.setNextPromptResult(answer); +}; + +Selenium.prototype.doGoBack = function() { + /** + * Simulates the user clicking the "back" button on their browser. + * + */ + this.page().goBack(); +}; + +Selenium.prototype.doRefresh = function() { + /** + * Simulates the user clicking the "Refresh" button on their browser. + * + */ + this.page().refresh(); +}; + +Selenium.prototype.doClose = function() { + /** + * Simulates the user clicking the "close" button in the titlebar of a popup + * window or tab. + */ + this.page().close(); +}; + +Selenium.prototype.isAlertPresent = function() { + /** + * Has an alert occurred? + * + *+ * This function never throws an exception + *
+ * @return boolean true if there is an alert + */ + return this.browserbot.hasAlerts(); +}; +Selenium.prototype.isPromptPresent = function() { + /** + * Has a prompt occurred? + * + *+ * This function never throws an exception + *
+ * @return boolean true if there is a pending prompt + */ + return this.browserbot.hasPrompts(); +}; +Selenium.prototype.isConfirmationPresent = function() { + /** + * Has confirm() been called? + * + *+ * This function never throws an exception + *
+ * @return boolean true if there is a pending confirmation + */ + return this.browserbot.hasConfirmations(); +}; +Selenium.prototype.getAlert = function() { + /** + * Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts. + * + *Getting an alert has the same effect as manually clicking OK. If an + * alert is generated but you do not get/verify it, the next Selenium action + * will fail.
+ * + *NOTE: under Selenium, JavaScript alerts will NOT pop up a visible alert + * dialog.
+ * + *NOTE: Selenium does NOT support JavaScript alerts that are generated in a + * page's onload() event handler. In this case a visible dialog WILL be + * generated and Selenium will hang until someone manually clicks OK.
+ * @return string The message of the most recent JavaScript alert + */ + if (!this.browserbot.hasAlerts()) { + Assert.fail("There were no alerts"); + } + return this.browserbot.getNextAlert(); +}; +Selenium.prototype.getAlert.dontCheckAlertsAndConfirms = true; + +Selenium.prototype.getConfirmation = function() { + /** + * Retrieves the message of a JavaScript confirmation dialog generated during + * the previous action. + * + *+ * By default, the confirm function will return true, having the same effect + * as manually clicking OK. This can be changed by prior execution of the + * chooseCancelOnNextConfirmation command. If an confirmation is generated + * but you do not get/verify it, the next Selenium action will fail. + *
+ * + *+ * NOTE: under Selenium, JavaScript confirmations will NOT pop up a visible + * dialog. + *
+ * + *+ * NOTE: Selenium does NOT support JavaScript confirmations that are + * generated in a page's onload() event handler. In this case a visible + * dialog WILL be generated and Selenium will hang until you manually click + * OK. + *
+ * + * @return string the message of the most recent JavaScript confirmation dialog + */ + if (!this.browserbot.hasConfirmations()) { + Assert.fail("There were no confirmations"); + } + return this.browserbot.getNextConfirmation(); +}; +Selenium.prototype.getConfirmation.dontCheckAlertsAndConfirms = true; + +Selenium.prototype.getPrompt = function() { + /** + * Retrieves the message of a JavaScript question prompt dialog generated during + * the previous action. + * + *Successful handling of the prompt requires prior execution of the + * answerOnNextPrompt command. If a prompt is generated but you + * do not get/verify it, the next Selenium action will fail.
+ * + *NOTE: under Selenium, JavaScript prompts will NOT pop up a visible + * dialog.
+ * + *NOTE: Selenium does NOT support JavaScript prompts that are generated in a + * page's onload() event handler. In this case a visible dialog WILL be + * generated and Selenium will hang until someone manually clicks OK.
+ * @return string the message of the most recent JavaScript question prompt + */ + if (! this.browserbot.hasPrompts()) { + Assert.fail("There were no prompts"); + } + return this.browserbot.getNextPrompt(); +}; + +Selenium.prototype.getLocation = function() { + /** Gets the absolute URL of the current page. + * + * @return string the absolute URL of the current page + */ + return this.page().location; +}; + +Selenium.prototype.getTitle = function() { + /** Gets the title of the current page. + * + * @return string the title of the current page + */ + return this.page().title(); +}; + + +Selenium.prototype.getBodyText = function() { + /** + * Gets the entire text of the page. + * @return string the entire text of the page + */ + return this.page().bodyText(); +}; + + +Selenium.prototype.getValue = function(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. + * + * @param locator an element locator + * @return string the element value, or "on/off" for checkbox/radio elements + */ + var element = this.page().findElement(locator) + return getInputValue(element).trim(); +} + +Selenium.prototype.getText = function(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. + * + * @param locator an element locator + * @return string the text of the element + */ + var element = this.page().findElement(locator); + return getText(element).trim(); +}; + +Selenium.prototype.getEval = function(script) { + /** Gets the result of evaluating the specified JavaScript snippet. The snippet may + * have multiple lines, but only the result of the last line will be returned. + * + *Note that, by default, the snippet will run in the context of the "selenium"
+ * object itself, so this will refer to the Selenium object, and window will
+ * refer to the top-level runner test window, not the window of your application.
If you need a reference to the window of your application, you can refer
+ * to this.browserbot.getCurrentWindow() and if you need to use
+ * a locator to refer to a single element in your application page, you can
+ * use this.page().findElement("foo") where "foo" is your locator.
See the select command for more information about option locators.
+ * + * @param selectLocator an element locator identifying a drop-down menu + * @param optionLocator an option locator, typically just an option label (e.g. "John Smith") + */ + var element = this.page().findElement(selectLocator); + var locator = this.optionLocatorFactory.fromLocatorString(optionLocator); + if (element.selectedIndex == -1) + { + Assert.fail("No option selected"); + } + locator.assertSelected(element); +}; + +Selenium.prototype.getSelectedLabels = function(selectLocator) { + /** Gets all option labels (visible text) for selected options in the specified select or multi-select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string[] an array of all selected option labels in the specified select drop-down + */ + return this.findSelectedOptionProperties(selectLocator, "text").join(","); +} + +Selenium.prototype.getSelectedLabel = function(selectLocator) { + /** Gets option label (visible text) for selected option in the specified select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string the selected option label in the specified select drop-down + */ + return this.findSelectedOptionProperty(selectLocator, "text"); +} + +Selenium.prototype.getSelectedValues = function(selectLocator) { + /** Gets all option values (value attributes) for selected options in the specified select or multi-select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string[] an array of all selected option values in the specified select drop-down + */ + return this.findSelectedOptionProperties(selectLocator, "value").join(","); +} + +Selenium.prototype.getSelectedValue = function(selectLocator) { + /** Gets option value (value attribute) for selected option in the specified select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string the selected option value in the specified select drop-down + */ + return this.findSelectedOptionProperty(selectLocator, "value"); +} + +Selenium.prototype.getSelectedIndexes = function(selectLocator) { + /** Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string[] an array of all selected option indexes in the specified select drop-down + */ + return this.findSelectedOptionProperties(selectLocator, "index").join(","); +} + +Selenium.prototype.getSelectedIndex = function(selectLocator) { + /** Gets option index (option number, starting at 0) for selected option in the specified select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string the selected option index in the specified select drop-down + */ + return this.findSelectedOptionProperty(selectLocator, "index"); +} + +Selenium.prototype.getSelectedIds = function(selectLocator) { + /** Gets all option element IDs for selected options in the specified select or multi-select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string[] an array of all selected option IDs in the specified select drop-down + */ + return this.findSelectedOptionProperties(selectLocator, "id").join(","); +} + +Selenium.prototype.getSelectedId = function(selectLocator) { + /** Gets option element ID for selected option in the specified select element. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string the selected option ID in the specified select drop-down + */ + return this.findSelectedOptionProperty(selectLocator, "id"); +} + +Selenium.prototype.isSomethingSelected = function(selectLocator) { + /** Determines whether some option in a drop-down menu is selected. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return boolean true if some option has been selected, false otherwise + */ + var element = this.page().findElement(selectLocator); + if (!("options" in element)) { + throw new SeleniumError("Specified element is not a Select (has no options)"); + } + + var selectedOptions = []; + + for (var i = 0; i < element.options.length; i++) { + if (element.options[i].selected) + { + return true; + } + } + return false; +} + +Selenium.prototype.findSelectedOptionProperties = function(locator, property) { + var element = this.page().findElement(locator); + if (!("options" in element)) { + throw new SeleniumError("Specified element is not a Select (has no options)"); + } + + var selectedOptions = []; + + for (var i = 0; i < element.options.length; i++) { + if (element.options[i].selected) + { + var propVal = element.options[i][property]; + if (propVal.replace) { + propVal.replace(/,/g, "\\,"); + } + selectedOptions.push(propVal); + } + } + if (selectedOptions.length == 0) Assert.fail("No option selected"); + return selectedOptions; +} + +Selenium.prototype.findSelectedOptionProperty = function(locator, property) { + var selectedOptions = this.findSelectedOptionProperties(locator, property); + if (selectedOptions.length > 1) { + Assert.fail("More than one selected option!"); + } + return selectedOptions[0]; +} + +Selenium.prototype.getSelectOptions = function(selectLocator) { + /** Gets all option labels in the specified select drop-down. + * + * @param selectLocator an element locator identifying a drop-down menu + * @return string[] an array of all option labels in the specified select drop-down + */ + var element = this.page().findElement(selectLocator); + + var selectOptions = []; + + for (var i = 0; i < element.options.length; i++) { + var option = element.options[i].text.replace(/,/g, "\\,"); + selectOptions.push(option); + } + + return selectOptions.join(","); +}; + + +Selenium.prototype.getAttribute = function(attributeLocator) { + /** + * Gets the value of an element attribute. + * @param attributeLocator an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar" + * @return string the value of the specified attribute + */ + var result = this.page().findAttribute(attributeLocator); + if (result == null) { + throw new SeleniumError("Could not find element attribute: " + attributeLocator); + } + return result; +}; + +Selenium.prototype.isTextPresent = function(pattern) { + /** + * Verifies that the specified text pattern appears somewhere on the rendered page shown to the user. + * @param pattern a pattern to match with the text of the page + * @return boolean true if the pattern matches the text, false otherwise + */ + var allText = this.page().bodyText(); + + if(allText == "") { + Assert.fail("Page text not found"); + } else { + var patternMatcher = new PatternMatcher(pattern); + if (patternMatcher.strategy == PatternMatcher.strategies.glob) { + patternMatcher.matcher = new PatternMatcher.strategies.globContains(pattern); + } + return patternMatcher.matches(allText); + } +}; + +Selenium.prototype.isElementPresent = function(locator) { + /** + * Verifies that the specified element is somewhere on the page. + * @param locator an element locator + * @return boolean true if the element is present, false otherwise + */ + try { + this.page().findElement(locator); + } catch (e) { + return false; + } + return true; +}; + +Selenium.prototype.isVisible = function(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. + * + * @param locator an element locator + * @return boolean true if the specified element is visible, false otherwise + */ + var element; + element = this.page().findElement(locator); + + if(/Konqueror|Safari|KHTML/.test(navigator.userAgent)) + var visibility = element.style["visibility"]; + else + var visibility = this.findEffectiveStyleProperty(element, "visibility"); + + var _isDisplayed = this._isDisplayed(element); + return (visibility != "hidden" && _isDisplayed); +}; + +Selenium.prototype.findEffectiveStyleProperty = function(element, property) { + var effectiveStyle = this.findEffectiveStyle(element); + var propertyValue = effectiveStyle[property]; + if (propertyValue == 'inherit' && element.parentNode.style) { + return this.findEffectiveStyleProperty(element.parentNode, property); + } + return propertyValue; +}; + +Selenium.prototype._isDisplayed = function(element) { + if(/Konqueror|Safari|KHTML/.test(navigator.userAgent)) + var display = element.style["display"]; + else + var display = this.findEffectiveStyleProperty(element, "display"); + if (display == "none") return false; + if (element.parentNode.style) { + return this._isDisplayed(element.parentNode); + } + return true; +}; + +Selenium.prototype.findEffectiveStyle = function(element) { + if (element.style == undefined) { + return undefined; // not a styled element + } + var window = this.browserbot.getContentWindow(); + if (window.getComputedStyle) { + // DOM-Level-2-CSS + return window.getComputedStyle(element, null); + } + if (element.currentStyle) { + // non-standard IE alternative + return element.currentStyle; + // TODO: this won't really work in a general sense, as + // currentStyle is not identical to getComputedStyle() + // ... but it's good enough for "visibility" + } + throw new SeleniumError("cannot determine effective stylesheet in this browser"); +}; + +Selenium.prototype.isEditable = function(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. + * + * @param locator an element locator + * @return boolean true if the input element is editable, false otherwise + */ + var element = this.page().findElement(locator); + if (element.value == undefined) { + Assert.fail("Element " + locator + " is not an input."); + } + return !element.disabled; +}; + +Selenium.prototype.getAllButtons = function() { + /** Returns the IDs of all buttons on the page. + * + *If a given button has no ID, it will appear as "" in this array.
+ * + * @return string[] the IDs of all buttons on the page + */ + return this.page().getAllButtons(); +}; + +Selenium.prototype.getAllLinks = function() { + /** Returns the IDs of all links on the page. + * + *If a given link has no ID, it will appear as "" in this array.
+ * + * @return string[] the IDs of all links on the page + */ + return this.page().getAllLinks(); +}; + +Selenium.prototype.getAllFields = function() { + /** Returns the IDs of all input fields on the page. + * + *If a given field has no ID, it will appear as "" in this array.
+ * + * @return string[] the IDs of all field on the page + */ + return this.page().getAllFields(); +}; + +Selenium.prototype.getHtmlSource = function() { + /** Returns the entire HTML source between the opening and + * closing "html" tags. + * + * @return string the entire HTML source + */ + return this.page().currentDocument.getElementsByTagName("html")[0].innerHTML; +}; + +Selenium.prototype.doSetCursorPosition = function(locator, 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. + * + * @param locator an element locator pointing to an input element or textarea + * @param 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. + */ + var element = this.page().findElement(locator); + if (element.value == undefined) { + Assert.fail("Element " + locator + " is not an input."); + } + if (position == -1) { + position = element.value.length; + } + + if( element.setSelectionRange && !browserVersion.isOpera) { + element.focus(); + element.setSelectionRange(/*start*/position,/*end*/position); + } + else if( element.createTextRange ) { + triggerEvent(element, 'focus', false); + var range = element.createTextRange(); + range.collapse(true); + range.moveEnd('character',position); + range.moveStart('character',position); + range.select(); + } +} + +Selenium.prototype.getCursorPosition = function(locator) { + /** + * Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers. + * + *Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to + * return the position of the last location of the cursor, even though the cursor is now gone from the page. This is filed as SEL-243.
+ * This method will fail if the specified element isn't an input element or textarea, or there is no cursor in the element. + * + * @param locator an element locator pointing to an input element or textarea + * @return number the numerical position of the cursor in the field + */ + var element = this.page().findElement(locator); + var doc = this.page().currentDocument; + var win = this.browserbot.getCurrentWindow(); + if( doc.selection && !browserVersion.isOpera){ + + var selectRange = doc.selection.createRange().duplicate(); + var elementRange = element.createTextRange(); + selectRange.move("character",0); + elementRange.move("character",0); + var inRange1 = selectRange.inRange(elementRange); + var inRange2 = elementRange.inRange(selectRange); + try { + elementRange.setEndPoint("EndToEnd", selectRange); + } catch (e) { + Assert.fail("There is no cursor on this page!"); + } + var answer = String(elementRange.text).replace(/\r/g,"").length; + return answer; + } else { + if (typeof(element.selectionStart) != undefined) { + if (win.getSelection && typeof(win.getSelection().rangeCount) != undefined && win.getSelection().rangeCount == 0) { + Assert.fail("There is no cursor on this page!"); + } + return element.selectionStart; + } + } + throw new Error("Couldn't detect cursor position on this browser!"); +} + + +Selenium.prototype.doSetContext = function(context, logLevelThreshold) { + /** + * Writes a message to the status bar and adds a note to the browser-side + * log. + * + *If logLevelThreshold is specified, set the threshold for logging + * to that level (debug, info, warn, error).
+ * + *(Note that the browser-side logs will not be sent back to the + * server, and are invisible to the Client Driver.)
+ * + * @param context + * the message to be sent to the browser + * @param logLevelThreshold one of "debug", "info", "warn", "error", sets the threshold for browser-side logging + */ + if (logLevelThreshold==null || logLevelThreshold=="") { + return this.page().setContext(context); + } + return this.page().setContext(context, logLevelThreshold); +}; + +Selenium.prototype.getExpression = function(expression) { + /** + * Returns the specified expression. + * + *This is useful because of JavaScript preprocessing. + * It is used to generate commands like assertExpression and storeExpression.
+ * + * @param expression the value to return + * @return string the value passed in + */ + return expression; +} + +Selenium.prototype.doWaitForCondition = function(script, 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
Actions that require waiting include "open" and the "waitFor*" actions.
+ * The default timeout is 30 seconds. + * @param timeout a timeout in milliseconds, after which the action will return with an error + */ + testLoop.waitForConditionTimeout = timeout; +} + +Selenium.prototype.doWaitForPageToLoad = function(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.
+ * @param timeout a timeout in milliseconds, after which this command will return with an error + */ + this.doWaitForCondition("selenium.browserbot.isNewPageLoaded()", timeout); +}; + +Selenium.prototype.doWaitForPageToLoad.dontCheckAlertsAndConfirms = true; + +/** + * Evaluate a parameter, performing JavaScript evaluation and variable substitution. + * If the string matches the pattern "javascript{ ... }", evaluate the string between the braces. + */ +Selenium.prototype.preprocessParameter = function(value) { + var match = value.match(/^javascript\{((.|\r?\n)+)\}$/); + if (match && match[1]) { + return eval(match[1]).toString(); + } + return this.replaceVariables(value); +}; + +/* + * Search through str and replace all variable references ${varName} with their + * value in storedVars. + */ +Selenium.prototype.replaceVariables = function(str) { + var stringResult = str; + + // Find all of the matching variable references + var match = stringResult.match(/\$\{\w+\}/g); + if (!match) { + return stringResult; + } + + // For each match, lookup the variable value, and replace if found + for (var i = 0; match && i < match.length; i++) { + var variable = match[i]; // The replacement variable, with ${} + var name = variable.substring(2, variable.length - 1); // The replacement variable without ${} + var replacement = storedVars[name]; + if (replacement != undefined) { + stringResult = stringResult.replace(variable, replacement); + } + } + return stringResult; +}; + + +/** + * Factory for creating "Option Locators". + * An OptionLocator is an object for dealing with Select options (e.g. for + * finding a specified option, or asserting that the selected option of + * Select element matches some condition. + * The type of locator returned by the factory depends on the locator string: + * label=