diff --git a/lib/WWW/Selenium.pm b/lib/WWW/Selenium.pm index d7543f4..4caad77 100644 --- a/lib/WWW/Selenium.pm +++ b/lib/WWW/Selenium.pm @@ -2801,6 +2801,29 @@ sub get_xpath_count { return $self->get_number("getXpathCount", @_); } +=item $sel-Eget_css_count($css) + +Returns the number of nodes that match the specified selector, eg. "css=table" would give the number of tables. + +=over + +=item $css is the css selector to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.. + +=back + +=over + +=item Returns the number of nodes that match the specified css selector + +=back + +=cut + +sub get_css_count { + my $self = shift; + return $self->get_number("getCssCount", @_); +} + =item $sel-Eassign_id($locator, $identifier) Temporarily sets the "id" attribute of the specified element, so you can locate it in the futureusing its ID rather than a slow/complicated XPath. This ID will disappear once the page isreloaded. diff --git a/t/selenium-core.t b/t/selenium-core.t index 51c5276..995c6a2 100644 --- a/t/selenium-core.t +++ b/t/selenium-core.t @@ -127,6 +127,7 @@ $sel->_method_exists("get_element_height"); $sel->_method_exists("get_cursor_position"); $sel->_method_exists("get_expression"); $sel->_method_exists("get_xpath_count"); +$sel->_method_exists("get_css_count"); $sel->_method_exists("assign_id"); $sel->_method_exists("allow_native_xpath"); $sel->_method_exists("ignore_attributes_without_value"); diff --git a/target/iedoc.xml b/target/iedoc.xml index c8f8658..9d39d39 100644 --- a/target/iedoc.xml +++ b/target/iedoc.xml @@ -1,7 +1,7 @@ - + - + Defines an object that runs Selenium commands.

Element Locators

@@ -152,301 +152,301 @@ When providing a pattern, the optional matching syntax (i.e. glob, regexp, etc.) is specified once, as usual, at the beginning of the pattern.

- + - + an element 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. - + - + - + an element 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. - + - + - + an element locator - + Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element). - + - + - + an element locator - + specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the 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. - + - + - + an element locator - + specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator. - + 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. - + - + - + an element locator - + specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator. - + Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element). - + - + - + an element locator - + the event name, e.g. "focus" or "blur" - + Explicitly simulate an event, to trigger the corresponding "onevent" handler. - + - + - + an element locator - + Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field. - + - + - + an element locator - + Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119". - + Simulates a user pressing and releasing a key. - + - + - + Press the shift key and hold it down until doShiftUp() is called or a new page is loaded. - + - + - + Release the shift key. - + - + - + Press the meta key and hold it down until doMetaUp() is called or a new page is loaded. - + - + - + Release the meta key. - + - + - + Press the alt key and hold it down until doAltUp() is called or a new page is loaded. - + - + - + Release the alt key. - + - + - + Press the control key and hold it down until doControlUp() is called or a new page is loaded. - + - + - + Release the control key. - + - + - + an element locator - + Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119". - + Simulates a user pressing a key (without releasing it yet). - + - + - + an element locator - + Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119". - + Simulates a user releasing a key. - + - + - + an element locator - + Simulates a user hovering a mouse over the specified element. - + - + - + an element locator - + Simulates a user moving the mouse pointer away from the specified element. - + - + - + an element locator - + Simulates a user pressing the left mouse button (without releasing it yet) on the specified element. - + - + - + an element locator - + Simulates a user pressing the right mouse button (without releasing it yet) on the specified element. - + - + - + an element locator - + specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator. - + Simulates a user pressing the left mouse button (without releasing it yet) at the specified location. - + - + - + an element locator - + specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator. - + Simulates a user pressing the right mouse button (without releasing it yet) at the specified location. - + - + - + an element locator - + Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) on the specified element. - + - + - + an element 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. - + - + - + an element locator - + specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator. - + Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) at the specified location. - + - + - + an element locator - + specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator. - + Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) at the specified location. - + - + - + an element locator - + Simulates a user pressing the mouse button (without releasing it yet) on the specified element. - + - + - + an element locator - + specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator. - + Simulates a user pressing the mouse button (without releasing it yet) on the specified element. - + - + - + an element locator - + the value to type - + 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.

 - + - + - + an element locator - + the value to type - + 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; @@ -458,51 +458,51 @@ For example, if you use "typeKeys" on a form element, you may or may not see the 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.

 - + - + - + the number of milliseconds to pause after operation - + 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. - + - + - + the execution speed in milliseconds. - + 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. - + - + - + an element locator - + Check a toggle-button (checkbox/radio) - + - + - + an element locator - + Uncheck a toggle-button (checkbox/radio) - + - + - + an element locator identifying a drop-down menu - + an option locator (a label by default) - + Select an option from a drop-down using an option locator.

@@ -545,54 +545,54 @@ matches an option based on its index (offset from zero).

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

- + - + - + an element locator identifying a multi-select box - + an option locator (a label by default) - + 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 - + - + - + an element locator identifying a multi-select box - + an option locator (a label by default) - + 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 - + - + - + an element locator identifying a multi-select box - + Unselects all of the selected options in a multi-select element. - + - + - + an element locator for the form you want to submit - + Submit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input "Search" forms. - + - + - + the URL to open; may be relative or absolute - + Opens an URL in the test frame. This accepts both relative and absolute URLs. @@ -603,15 +603,15 @@ ie. the "AndWait" suffix is implicit. 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. - + - + - + the URL to open, which can be blank - + the JavaScript window ID of the window to select - + 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. @@ -619,13 +619,13 @@ 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").

 - + - + - + the JavaScript window ID of the window to select - + 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. @@ -670,13 +670,13 @@ like the following for each window as it is opened:

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

 - + - + - + an identifier for the popup window, which can take on a number of different meanings - + Simplifies the process of selecting a popup window (and does not offer functionality beyond what selectWindow() already provides).
    @@ -692,21 +692,21 @@ variable which is a reference to a window; and 3) the title of the window. This is the same ordered lookup performed by selectWindow .
- + - + - + Selects the main window. Functionally equivalent to using selectWindow() and specifying no value for windowID. - + - + - + an element locator identifying a frame or iframe - + 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". @@ -715,17 +715,17 @@ You can also select a frame by its 0-based index number; select the first frame

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

 - + - + - + true if the new frame is this code's window - + starting frame - + new frame (which might be relative to the current one) - + Determine whether current/locator identify the frame containing this running code.

This is useful in proxy injection mode, where this code runs in every @@ -733,17 +733,17 @@ browser frame and window, and sometimes the selenium server needs to identify the "current" frame. In this case, when the test calls selectFrame, this routine is called for each frame to figure out which one has been selected. The selected frame will return true, while all others will return false.

 - + - + - + true if the new window is this code's window - + starting window - + new window (which might be relative to the current one, e.g., "_parent") - + Determine whether currentWindowString plus target identify the window containing this running code.

This is useful in proxy injection mode, where this code runs in every @@ -751,21 +751,21 @@ browser frame and window, and sometimes the selenium server needs to identify the "current" window. In this case, when the test calls selectWindow, this routine is called for each window to figure out which one has been selected. The selected window will return true, while all others will return false.

 - + - + - + the JavaScript window "name" of the window that will appear (not the text of the title bar) If unspecified, or specified as "null", this command will wait for the first non-top window to appear (don't rely on this if you are working with multiple popups simultaneously). - + a timeout in milliseconds, after which the action will return with an error. If this value is not specified, the default Selenium timeout will be used. See the setTimeout() command. - + Waits for a popup window to appear and load up. - + - + - +

By default, Selenium's overridden window.confirm() function will return true, as if the user had manually clicked OK; after running @@ -780,11 +780,11 @@ Take note - every time a confirmation comes up, you must consume it with a corresponding getConfirmation, or else the next selenium operation will fail.

- + - + - +

Undo the effect of calling chooseCancelOnNextConfirmation. Note that Selenium's overridden window.confirm() function will normally automatically @@ -800,77 +800,77 @@ Take note - every time a confirmation comes up, you must consume it with a corresponding getConfirmation, or else the next selenium operation will fail.

- + - + - + the answer to give in response to the prompt pop-up - + Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()]. - + - + - + Simulates the user clicking the "back" button on their browser. - + - + - + Simulates the user clicking the "Refresh" button on their browser. - + - + - + Simulates the user clicking the "close" button in the titlebar of a popup window or tab. - + - + - + true if there is an alert - + Has an alert occurred?

This function never throws an exception

- + - + - + true if there is a pending prompt - + Has a prompt occurred?

This function never throws an exception

- + - + - + true if there is a pending confirmation - + Has confirm() been called?

This function never throws an exception

- + - + - + The message of the most recent JavaScript alert - + 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 @@ -883,13 +883,13 @@ 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.

 - + - + - + the message of the most recent JavaScript confirmation dialog - + Retrieves the message of a JavaScript confirmation dialog generated during the previous action. @@ -914,13 +914,13 @@ 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.

- + - + - + the message of the most recent JavaScript question prompt - + Retrieves the message of a JavaScript question prompt dialog generated during the previous action. @@ -934,72 +934,72 @@ 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.

 - + - + - + the absolute URL of the current page - + Gets the absolute URL of the current page. - + - + - + the title of the current page - + Gets the title of the current page. - + - + - + the entire text of the page - + Gets the entire text of the page. - + - + - + the element value, or "on/off" for checkbox/radio elements - + an element 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. - + - + - + the text of the element - + an element 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. - + - + - + an element locator - + Briefly changes the backgroundColor of the specified element yellow. Useful for debugging. - + - + - + the results of evaluating the snippet - + the JavaScript snippet to run - + 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. @@ -1010,241 +1010,241 @@ refer to the window of your application, e.g. window.document.getElementBy

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.

 - + - + - + true if the checkbox is checked, false otherwise - + an element locator pointing to a checkbox or radio button - + Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button. - + - + - + the text from the specified cell - + a cell address, e.g. "foo.1.4" - + Gets the text from a cell of a table. The cellAddress syntax tableLocator.row.column, where row and column start at 0. - + - + - + an array of all selected option labels in the specified select drop-down - + an element locator identifying a drop-down menu - + Gets all option labels (visible text) for selected options in the specified select or multi-select element. - + - + - + the selected option label in the specified select drop-down - + an element locator identifying a drop-down menu - + Gets option label (visible text) for selected option in the specified select element. - + - + - + an array of all selected option values in the specified select drop-down - + an element locator identifying a drop-down menu - + Gets all option values (value attributes) for selected options in the specified select or multi-select element. - + - + - + the selected option value in the specified select drop-down - + an element locator identifying a drop-down menu - + Gets option value (value attribute) for selected option in the specified select element. - + - + - + an array of all selected option indexes in the specified select drop-down - + an element locator identifying a drop-down menu - + Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element. - + - + - + the selected option index in the specified select drop-down - + an element locator identifying a drop-down menu - + Gets option index (option number, starting at 0) for selected option in the specified select element. - + - + - + an array of all selected option IDs in the specified select drop-down - + an element locator identifying a drop-down menu - + Gets all option element IDs for selected options in the specified select or multi-select element. - + - + - + the selected option ID in the specified select drop-down - + an element locator identifying a drop-down menu - + Gets option element ID for selected option in the specified select element. - + - + - + true if some option has been selected, false otherwise - + an element locator identifying a drop-down menu - + Determines whether some option in a drop-down menu is selected. - + - + - + an array of all option labels in the specified select drop-down - + an element locator identifying a drop-down menu - + Gets all option labels in the specified select drop-down. - + - + - + the value of the specified attribute - + an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar" - + 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). - + - + - + true if the pattern matches the text, false otherwise - + a pattern to match with the text of the page - + Verifies that the specified text pattern appears somewhere on the rendered page shown to the user. - + - + - + true if the element is present, false otherwise - + an element locator - + Verifies that the specified element is somewhere on the page. - + - + - + true if the specified element is visible, false otherwise - + an element 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. - + - + - + true if the input element is editable, false otherwise - + an element 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. - + - + - + the IDs of all buttons on the page - + Returns the IDs of all buttons on the page.

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

 - + - + - + the IDs of all links on the page - + Returns the IDs of all links on the page.

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

 - + - + - + the IDs of all field on the page - + Returns the IDs of all input fields on the page.

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

 - + - + - + the set of values of this attribute from all known windows. - + name of an attribute on the windows - + Returns an array of JavaScript property values from all known windows having one. - + - + - + an element locator - + offset in pixels from the current location to which the element should be moved, e.g., "+70,-300" - + deprecated - use dragAndDrop instead - + - + - + the number of pixels between "mousemove" events - + 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 @@ -1252,224 +1252,235 @@ 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.

 - + - + - + the number of pixels between "mousemove" events during dragAndDrop commands (default=10) - + Returns the number of pixels between "mousemove" events during dragAndDrop commands (default=10). - + - + - + an element locator - + offset in pixels from the current location to which the element should be moved, e.g., "+70,-300" - + Drags an element a certain distance and then drops it - + - + - + an element to be dragged - + an element whose location (i.e., whose center-most pixel) will be the point where locatorOfObjectToBeDragged is dropped - + Drags an element and drops it on another element - + - + - + Gives focus to the currently selected window - + - + - + Resize currently selected window to take up the entire screen - + - + - + Array of identifiers of all windows that the browser knows about. - + Returns the IDs of all windows that the browser knows about in an array. - + - + - + Array of names of all windows that the browser knows about. - + Returns the names of all windows that the browser knows about in an array. - + - + - + Array of titles of all windows that the browser knows about. - + Returns the titles of all windows that the browser knows about in an array. - + - + - + the entire HTML source - + Returns the entire HTML source between the opening and closing "html" tags. - + - + - + an element locator pointing to an input element or textarea - + 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. - + 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. - + - + - + of relative index of the element to its parent (starting from 0) - + an element locator pointing to an element - + Get the relative index of an element to its parent (starting from 0). The comment node and empty text node will be ignored. - + - + - + true if element1 is the previous sibling of element2, false otherwise - + an element locator pointing to the first element - + an element locator pointing to the second element - + Check if these two elements have same parent and are ordered siblings in the DOM. Two same elements will not be considered ordered. - + - + - + of pixels from the edge of the frame. - + an element locator pointing to an element OR an element itself - + Retrieves the horizontal position of an element - + - + - + of pixels from the edge of the frame. - + an element locator pointing to an element OR an element itself - + Retrieves the vertical position of an element - + - + - + width of an element in pixels - + an element locator pointing to an element - + Retrieves the width of an element - + - + - + height of an element in pixels - + an element locator pointing to an element - + Retrieves the height of an element - + - + - + the numerical position of the cursor in the field - + an element locator pointing to an input element or textarea - + 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. - + - + - + the value passed in - + the value to return - + Returns the specified expression.

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

 - + - + - + the number of nodes that match the specified 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, eg. "//table" would give the number of tables. - + - + + + +the number of nodes that match the specified css selector + +the css selector 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 selector, eg. "css=table" would give +the number of tables. + + + - + an element locator pointing to an element - + a string to be used as the ID of the specified element - + 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. - + - + - + boolean, true means we'll prefer to use native XPath; false means we'll only use JS XPath - + Specifies whether Selenium should use the native in-browser implementation of XPath (if any native version is available); if you pass "false" to this function, we will always use our pure-JavaScript xpath library. Using the pure-JS xpath library can improve the consistency of xpath element locators between different browser vendors, but the pure-JS version is much slower than the native implementations. - + - + - + boolean, true means we'll ignore attributes without value at the expense of xpath "correctness"; false means we'll sacrifice speed for correctness. - + 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. @@ -1479,15 +1490,15 @@ 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"). - + - + - + the JavaScript snippet to run - + a timeout in milliseconds, after which this command will return with an error - + 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. @@ -1496,24 +1507,24 @@ will be considered. 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

 - + - + - + a timeout in milliseconds, after which the action will return with an error - + Specifies the amount of time that Selenium will wait for actions to complete.

Actions that require waiting include "open" and the "waitFor*" actions.

The default timeout is 30 seconds. - + - + - + a timeout in milliseconds, after which this command will return with an error - + Waits for a new page to load.

You can use this command instead of the "AndWait" suffixes, "clickAndWait", "selectAndWait", "typeAndWait" etc. @@ -1523,69 +1534,69 @@ The default timeout is 30 seconds. 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.

 - + - + - + FrameAddress from the server side - + a timeout in milliseconds, after which this command will return with an error - + 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. - + - + - + all cookies of the current page under test - + Return all cookies of the current page under test. - + - + - + the value of the cookie - + the name of the cookie - + Returns the value of the cookie with the specified name, or throws an error if the cookie is not present. - + - + - + true if a cookie with the specified name is present, or false otherwise. - + the name of the cookie - + Returns true if a cookie with the specified name is present, or false otherwise. - + - + - + name and value of the cookie in a format "name=value" - + 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. - + 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. - + - + - + the name of the cookie to be deleted - + 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. - + 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 @@ -1596,32 +1607,32 @@ we've added an option called 'recurse' to try all sub-domains of the current dom 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. - + - + - + 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. - + - + - + one of the following: "debug", "info", "warn", "error" or "off" - + 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. - + - + - + the JavaScript snippet to run - + 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 @@ -1629,15 +1640,15 @@ 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. - + - + - + the name of the strategy to define; this should use only letters [a-zA-Z] with no spaces or other punctuation. - + a string defining the body of a function in JavaScript. For example: return inDocument.getElementById(locator); - + 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 @@ -1652,15 +1663,15 @@ We'll pass three arguments to your function:
  • inDocument: the currently selected document
    • The function must return null if the element can't be found.     - +     - + - + the path to the file to persist the screenshot as. No filename extension will be appended by default. Directories will not be created if they do not exist, and an exception will be thrown, possibly by native code. - + a kwargs string that modifies the way the screenshot is captured. Example: "background=#CCFFDD" . Currently valid options:
    background
    the background CSS for the HTML document. This may be useful to set for capturing screenshots of less-than-ideal layouts, for example where absolute positioning causes the calculation of the canvas dimension to fail and a black background is exposed (possibly obscuring black text).
    - + Saves the entire contents of the current window canvas to a PNG file. Contrast this with the captureScreenshot command, which captures the contents of the OS viewport (i.e. whatever is currently being displayed @@ -1670,28 +1681,28 @@ the EXPERIMENTAL "Snapsie" utility. The Firefox implementation is mostly borrowed from the Screengrab! Firefox extension. Please see http://www.screengrab.org and http://snapsie.sourceforge.net/ for details. - +     - + - + the name of the rollup command - + keyword arguments string that influences how the rollup expands into commands - + 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. - + - + - + the Javascript content of the script to add - + (optional) the id of the new script tag. If specified, and an element with this id already exists, this operation will fail. - + Loads script content into a new script tag in the Selenium document. This differs from the runScript command in that runScript adds the script tag to the document of the AUT, not the Selenium document. The following @@ -1703,128 +1714,128 @@ represent: & The corresponding remove command is removeScript. - + - + - + the id of the script element to remove. - + Removes a script tag from the Selenium document identified by the given id. Does nothing if the referenced tag doesn't exist. - + - + - + 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. - + Allows choice of one of the available libraries. - +     - + - + the message to be sent to the browser - + Writes a message to the status bar and adds a note to the browser-side log. - + - + - + an element locator - + a URL pointing to the specified file. Before the file can be set in the input field (fieldLocator), Selenium RC may need to transfer the file to the local machine before attaching the file in a web page form. This is common in selenium grid configurations where the RC server driving the browser is not the same machine that started the test. Supported Browsers: Firefox ("*chrome") only. - + Sets a file input (upload) field to the file listed in fileLocator - + - + - + the absolute path to the file to be written, e.g. "c:\blah\screenshot.png" - + Captures a PNG screenshot to the specified file. - + - + - + The base 64 encoded string of the screen shot (PNG file) - + Capture a PNG screenshot. It then returns the file as a base 64 encoded string. - + - + - + The base 64 encoded string of the page screenshot (PNG file) - + A kwargs string that modifies the way the screenshot is captured. Example: "background=#CCFFDD". This may be useful to set for capturing screenshots of less-than-ideal layouts, for example where absolute positioning causes the calculation of the canvas dimension to fail and a black background is exposed (possibly obscuring black text). - + Downloads a screenshot of the browser current window canvas to a based 64 encoded PNG file. The entire windows canvas is captured, including parts rendered outside of the current view port. Currently this only works in Mozilla and when running in chrome mode. - + - + - + Kills the running Selenium Server and all browser sessions. After you run this command, you will no longer be able to send commands to the server; you can't remotely start the server once it has been stopped. Normally you should prefer to run the "stop" command, which terminates the current browser session, rather than shutting down the entire server. - + - + - + The last N log messages as a multi-line string. - + Retrieve the last messages logged on a specific remote control. Useful for error reports, especially when running multiple remote controls in a distributed environment. The maximum number of log messages that can be retrieve is configured on remote control startup. - + - + - + an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes! - + Simulates a user pressing a key (without releasing it yet) by sending a native operating system keystroke. This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command. - + - + - + an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes! - + Simulates a user releasing a key by sending a native operating system keystroke. This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command. - + - + - + an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes! - + Simulates a user pressing and releasing a key by sending a native operating system keystroke. This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command. - + - -     + +