Metacat

<?xml version="1.0" encoding="UTF-8"?>

<apidoc>

<top>Defines an object that runs Selenium commands.

<h3><a name="locators"></a>Element Locators</h3>

<p>

Element Locators tell Selenium which HTML element a command refers to.

The format of a locator is:</p>

<blockquote>

<em>locatorType</em><strong>=</strong><em>argument</em>

</blockquote>

<p>

We support the following strategies for locating elements:

</p>

<ul>

<li><strong>identifier</strong>=<em>id</em>: 

Select the element with the specified @id attribute. If no match is

found, select the first element whose &#64;name attribute is <em>id</em>.

(This is normally the default; see below.)</li>

<li><strong>id</strong>=<em>id</em>:

Select the element with the specified &#64;id attribute.</li>

<li><strong>name</strong>=<em>name</em>:

Select the first element with the specified @name attribute.

<ul class="first last simple">

<li>username</li>

<li>name=username</li>

</ul>

<p>The name may optionally be followed by one or more <em>element-filters</em>, separated from the name by whitespace.  If the <em>filterType</em> is not specified, <strong>value</strong> is assumed.</p>

<ul class="first last simple">

<li>name=flavour value=chocolate</li>

</ul>

</li>

<li><strong>dom</strong>=<em>javascriptExpression</em>: 

Find an element by evaluating the specified string.  This allows you to traverse the HTML Document Object

Model using JavaScript.  Note that you must not return a value in this string; simply make it the last expression in the block.

<ul class="first last simple">

<li>dom=document.forms['myForm'].myDropdown</li>

<li>dom=document.images[56]</li>

<li>dom=function foo() { return document.links[1]; }; foo();</li>

</ul>

</li>

<li><strong>xpath</strong>=<em>xpathExpression</em>: 

Locate an element using an XPath expression.

<ul class="first last simple">

<li>xpath=//img[&#64;alt='The image alt text']</li>

<li>xpath=//table[&#64;id='table1']//tr[4]/td[2]</li>

<li>xpath=//a[contains(&#64;href,'#id1')]</li>

<li>xpath=//a[contains(&#64;href,'#id1')]/&#64;class</li>

<li>xpath=(//table[&#64;class='stylee'])//th[text()='theHeaderText']/../td</li>

<li>xpath=//input[&#64;name='name2' and &#64;value='yes']</li>

<li>xpath=//*[text()="right"]</li>

</ul>

</li>

<li><strong>link</strong>=<em>textPattern</em>:

Select the link (anchor) element which contains text matching the

specified <em>pattern</em>.

<ul class="first last simple">

<li>link=The link text</li>

</ul>

</li>

<li><strong>css</strong>=<em>cssSelectorSyntax</em>:

Select the element using css selectors. Please refer to <a href="http://www.w3.org/TR/REC-CSS2/selector.html">CSS2 selectors</a>, <a href="http://www.w3.org/TR/2001/CR-css3-selectors-20011113/">CSS3 selectors</a> for more information. You can also check the TestCssLocators test in the selenium test suite for an example of usage, which is included in the downloaded selenium core package.

<ul class="first last simple">

<li>css=a[href="#id3"]</li>

<li>css=span#firstChild + span</li>

</ul>

<p>Currently the css selector locator supports all css1, css2 and css3 selectors except namespace in css3, some pseudo classes(:nth-of-type, :nth-last-of-type, :first-of-type, :last-of-type, :only-of-type, :visited, :hover, :active, :focus, :indeterminate) and pseudo elements(::first-line, ::first-letter, ::selection, ::before, ::after). </p>

</li>

</ul>

<p>

Without an explicit locator prefix, Selenium uses the following default

strategies:

</p>

<ul class="simple">

<li><strong>dom</strong>, for locators starting with &quot;document.&quot;</li>

<li><strong>xpath</strong>, for locators starting with &quot;//&quot;</li>

<li><strong>identifier</strong>, otherwise</li>

</ul>

<h3><a name="element-filters">Element Filters</a></h3>

<blockquote>

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

<p>Filters look much like locators, ie.</p>

<blockquote>

<em>filterType</em><strong>=</strong><em>argument</em></blockquote>

<p>Supported element-filters are:</p>

<p><strong>value=</strong><em>valuePattern</em></p>

<blockquote>

Matches elements based on their values.  This is particularly useful for refining a list of similarly-named toggle-buttons.</blockquote>

<p><strong>index=</strong><em>index</em></p>

<blockquote>

Selects a single element based on its position in the list (offset from zero).</blockquote>

</blockquote>

<h3><a name="patterns"></a>String-match Patterns</h3>

<p>

Various Pattern syntaxes are available for matching string values:

</p>

<ul>

<li><strong>glob:</strong><em>pattern</em>:

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

<li><strong>regexp:</strong><em>regexp</em>:

Match a string using a regular-expression. The full power of JavaScript

regular-expressions is available.</li>

<li><strong>exact:</strong><em>string</em>:

Match a string exactly, verbatim, without any of that fancy wildcard

stuff.</li>

</ul>

<p>

If no pattern prefix is specified, Selenium assumes that it's a "glob"

pattern.

</p></top>

<function name="click">

<param name="locator">an element locator</param>

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

</function>

<function name="doubleClick">

<param name="locator">an element locator</param>

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

</function>

<function name="clickAt">

<param name="locator">an element locator</param>

<param name="coordString">specifies the x,y position (i.e. - 10,20) of the mouse      event relative to the element returned by the locator.</param>

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

</function>

<function name="doubleClickAt">

<param name="locator">an element locator</param>

<param name="coordString">specifies the x,y position (i.e. - 10,20) of the mouse      event relative to the element returned by the locator.</param>

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

</function>

<function name="fireEvent">

<param name="locator">an <a href="#locators">element locator</a></param>

<param name="eventName">the event name, e.g. "focus" or "blur"</param>

<comment>Explicitly simulate an event, to trigger the corresponding &quot;on<em>event</em>&quot;

handler.</comment>

</function>

<function name="keyPress">

<param name="locator">an <a href="#locators">element locator</a></param>

<param name="keySequence">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".</param>

<comment>Simulates a user pressing and releasing a key.</comment>

</function>

<function name="shiftKeyDown">

<comment>Press the shift key and hold it down until doShiftUp() is called or a new page is loaded.</comment>

</function>

<function name="shiftKeyUp">

<comment>Release the shift key.</comment>

</function>

<function name="metaKeyDown">

<comment>Press the meta key and hold it down until doMetaUp() is called or a new page is loaded.</comment>

</function>

<function name="metaKeyUp">

<comment>Release the meta key.</comment>

</function>

<function name="altKeyDown">

<comment>Press the alt key and hold it down until doAltUp() is called or a new page is loaded.</comment>

</function>

<function name="altKeyUp">

<comment>Release the alt key.</comment>

</function>

<function name="controlKeyDown">

<comment>Press the control key and hold it down until doControlUp() is called or a new page is loaded.</comment>

</function>

<function name="controlKeyUp">

<comment>Release the control key.</comment>

</function>

<function name="keyDown">

<param name="locator">an <a href="#locators">element locator</a></param>

<param name="keySequence">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".</param>

<comment>Simulates a user pressing a key (without releasing it yet).</comment>

</function>

<function name="keyUp">

<param name="locator">an <a href="#locators">element locator</a></param>

<param name="keySequence">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".</param>

<comment>Simulates a user releasing a key.</comment>

</function>

<function name="mouseOver">

<param name="locator">an <a href="#locators">element locator</a></param>

<comment>Simulates a user hovering a mouse over the specified element.</comment>

</function>

<function name="mouseOut">

<param name="locator">an <a href="#locators">element locator</a></param>

<comment>Simulates a user moving the mouse pointer away from the specified element.</comment>

</function>

<function name="mouseDown">

<param name="locator">an <a href="#locators">element locator</a></param>

<comment>Simulates a user pressing the mouse button (without releasing it yet) on

the specified element.</comment>

</function>

<function name="mouseDownAt">

<param name="locator">an <a href="#locators">element locator</a></param>

<param name="coordString">specifies the x,y position (i.e. - 10,20) of the mouse      event relative to the element returned by the locator.</param>

<comment>Simulates a user pressing the mouse button (without releasing it yet) on

the specified element.</comment>

</function>

<function name="mouseUp">

<param name="locator">an <a href="#locators">element locator</a></param>

<comment>Simulates a user pressing the mouse button (without releasing it yet) on

the specified element.</comment>

</function>

<function name="mouseUpAt">

<param name="locator">an <a href="#locators">element locator</a></param>

<param name="coordString">specifies the x,y position (i.e. - 10,20) of the mouse      event relative to the element returned by the locator.</param>

<comment>Simulates a user pressing the mouse button (without releasing it yet) on

the specified element.</comment>

</function>

<function name="mouseMove">

<param name="locator">an <a href="#locators">element locator</a></param>

<comment>Simulates a user pressing the mouse button (without releasing it yet) on

the specified element.</comment>

</function>

<function name="mouseMoveAt">

<param name="locator">an <a href="#locators">element locator</a></param>

<param name="coordString">specifies the x,y position (i.e. - 10,20) of the mouse      event relative to the element returned by the locator.</param>

<comment>Simulates a user pressing the mouse button (without releasing it yet) on

the specified element.</comment>

</function>

<function name="type">

<param name="locator">an <a href="#locators">element locator</a></param>

<param name="value">the value to type</param>

<comment>Sets the value of an input field, as though you typed it in.

<p>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.</p></comment>

</function>

<function name="typeKeys">

<param name="locator">an <a href="#locators">element locator</a></param>

<param name="value">the value to type</param>

<comment>Simulates keystroke events on the specified element, as though you typed the value key-by-key.

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

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

<p>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.</p></comment>

</function>

<function name="setSpeed">

<param name="value">the number of milliseconds to pause after operation</param>

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

</function>

<function name="getSpeed">

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

</function>

<function name="check">

<param name="locator">an <a href="#locators">element locator</a></param>

<comment>Check a toggle-button (checkbox/radio)</comment>

</function>

<function name="uncheck">

<param name="locator">an <a href="#locators">element locator</a></param>

<comment>Uncheck a toggle-button (checkbox/radio)</comment>

</function>

<function name="select">

<param name="selectLocator">an <a href="#locators">element locator</a> identifying a drop-down menu</param>

<param name="optionLocator">an option locator (a label by default)</param>

<comment>Select an option from a drop-down using an option locator.

<p>

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.

</p>

<ul>

<li><strong>label</strong>=<em>labelPattern</em>:

matches options based on their labels, i.e. the visible text. (This

is the default.)

<ul class="first last simple">

<li>label=regexp:^[Oo]ther</li>

</ul>

</li>

<li><strong>value</strong>=<em>valuePattern</em>:

matches options based on their values.

<ul class="first last simple">

<li>value=other</li>

</ul>

</li>

<li><strong>id</strong>=<em>id</em>:

matches options based on their ids.

<ul class="first last simple">

<li>id=option1</li>

</ul>

</li>

<li><strong>index</strong>=<em>index</em>:

matches an option based on its index (offset from zero).

<ul class="first last simple">

<li>index=2</li>

</ul>

</li>

</ul>

<p>

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

</p></comment>

</function>

<function name="addSelection">

<param name="locator">an <a href="#locators">element locator</a> identifying a multi-select box</param>

<param name="optionLocator">an option locator (a label by default)</param>

<comment>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</comment>

</function>

<function name="removeSelection">

<param name="locator">an <a href="#locators">element locator</a> identifying a multi-select box</param>

<param name="optionLocator">an option locator (a label by default)</param>

<comment>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</comment>

</function>

<function name="removeAllSelections">

<param name="locator">an <a href="#locators">element locator</a> identifying a multi-select box</param>

<comment>Unselects all of the selected options in a multi-select element.</comment>

</function>

<function name="submit">

<param name="formLocator">an <a href="#locators">element locator</a> for the form you want to submit</param>

<comment>Submit the specified form. This is particularly useful for forms without

submit buttons, e.g. single-input "Search" forms.</comment>

</function>

<function name="open">

<param name="url">the URL to open; may be relative or absolute</param>

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

<em>Note</em>: 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.</comment>

</function>

<function name="openWindow">

<param name="url">the URL to open, which can be blank</param>

<param name="windowID">the JavaScript window ID of the window to select</param>

<comment>Opens a popup window (if a window with that ID isn't already open).

After opening the window, you'll need to select it using the selectWindow

command.

<p>This command can also be a useful workaround for bug SEL-339.  In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example).

In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using

an empty (blank) url, like this: openWindow("", "myFunnyWindow").</p></comment>

</function>

<function name="selectWindow">

<param name="windowID">the JavaScript window ID of the window to select</param>

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

<p>Selenium has several strategies for finding the window object referred to by the "windowID" parameter.</p>

<p>1.) if windowID is null, then it is assumed the user is referring to the original window instantiated by the browser).</p>

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

<p>3.) Otherwise, selenium looks in a hash it maintains that maps string names to window objects.  Each of these string 

names matches the second parameter "windowName" past to the JavaScript method  window.open(url, windowName, windowFeatures, replaceFlag)

(which selenium intercepts).</p>

<p>If you're having trouble figuring out what is the name of a window that you want to manipulate, look at the selenium log messages

which identify the names of windows created via window.open (and therefore intercepted by selenium).  You will see messages

like the following for each window as it is opened:</p>

<p><code>debug: window.open call intercepted; window ID (which you can use with selectWindow()) is "myNewWindow"</code></p>

<p>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").</p></comment>

</function>

<function name="selectFrame">

<param name="locator">an <a href="#locators">element locator</a> identifying a frame or iframe</param>

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

<p>You may also use a DOM expression to identify the frame you want directly,

like this: <code>dom=frames["main"].frames["subframe"]</code></p></comment>

</function>

<function name="getLogMessages">

<return type="string">all log messages seen since the last call to this API</return>

<comment>Return the contents of the log.

<p>This is a placeholder intended to make the code generator make this API

available to clients.  The selenium server will intercept this call, however,

and return its recordkeeping of log messages since the last call to this API.

Thus this code in JavaScript will never be called.</p>

<p>The reason I opted for a servercentric solution is to be able to support

multiple frames served from different domains, which would break a

centralized JavaScript logging mechanism under some conditions.</p></comment>

</function>

<function name="getWhetherThisFrameMatchFrameExpression">

<return type="boolean">true if the new frame is this code's window</return>

<param name="currentFrameString">starting frame</param>

<param name="target">new frame (which might be relative to the current one)</param>

<comment>Determine whether current/locator identify the frame containing this running code.

<p>This is useful in proxy injection mode, where this code runs in every

browser frame and window, and sometimes the selenium server needs to identify

the "current" frame.  In this case, when the test calls selectFrame, this

routine is called for each frame to figure out which one has been selected.

The selected frame will return true, while all others will return false.</p></comment>

</function>

<function name="getWhetherThisWindowMatchWindowExpression">

<return type="boolean">true if the new window is this code's window</return>

<param name="currentWindowString">starting window</param>

<param name="target">new window (which might be relative to the current one, e.g., "_parent")</param>

<comment>Determine whether currentWindowString plus target identify the window containing this running code.

<p>This is useful in proxy injection mode, where this code runs in every

browser frame and window, and sometimes the selenium server needs to identify

the "current" window.  In this case, when the test calls selectWindow, this

routine is called for each window to figure out which one has been selected.

The selected window will return true, while all others will return false.</p></comment>

</function>

<function name="waitForPopUp">

<param name="windowID">the JavaScript window ID of the window that will appear</param>

<param name="timeout">a timeout in milliseconds, after which the action will return with an error</param>

<comment>Waits for a popup window to appear and load up.</comment>

</function>

<function name="chooseCancelOnNextConfirmation">

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

</function>

<function name="answerOnNextPrompt">

<param name="answer">the answer to give in response to the prompt pop-up</param>

<comment>Instructs Selenium to return the specified answer string in response to

the next JavaScript prompt [window.prompt()].</comment>

</function>

<function name="goBack">

<comment>Simulates the user clicking the "back" button on their browser.</comment>

</function>

<function name="refresh">

<comment>Simulates the user clicking the "Refresh" button on their browser.</comment>

</function>

<function name="close">

<comment>Simulates the user clicking the "close" button in the titlebar of a popup

window or tab.</comment>

</function>

<function name="isAlertPresent">

<return type="boolean">true if there is an alert</return>

<comment>Has an alert occurred?

<p>

This function never throws an exception

</p></comment>

</function>

<function name="isPromptPresent">

<return type="boolean">true if there is a pending prompt</return>

<comment>Has a prompt occurred?

<p>

This function never throws an exception

</p></comment>

</function>

<function name="isConfirmationPresent">

<return type="boolean">true if there is a pending confirmation</return>

<comment>Has confirm() been called?

<p>

This function never throws an exception

</p></comment>

</function>

<function name="getAlert">

<return type="string">The message of the most recent JavaScript alert</return>

<comment>Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts.

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

<p>NOTE: under Selenium, JavaScript alerts will NOT pop up a visible alert

dialog.</p>

<p>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.</p></comment>

</function>

<function name="getConfirmation">

<return type="string">the message of the most recent JavaScript confirmation dialog</return>

<comment>Retrieves the message of a JavaScript confirmation dialog generated during

the previous action.

<p>

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.

</p>

<p>

NOTE: under Selenium, JavaScript confirmations will NOT pop up a visible

dialog.

</p>

<p>

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.

</p></comment>

</function>

<function name="getPrompt">

<return type="string">the message of the most recent JavaScript question prompt</return>

<comment>Retrieves the message of a JavaScript question prompt dialog generated during

the previous action.

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

<p>NOTE: under Selenium, JavaScript prompts will NOT pop up a visible

dialog.</p>

<p>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.</p></comment>

</function>

<function name="getLocation">

<return type="string">the absolute URL of the current page</return>

<comment>Gets the absolute URL of the current page.</comment>

</function>

<function name="getTitle">

<return type="string">the title of the current page</return>

<comment>Gets the title of the current page.</comment>

</function>

<function name="getBodyText">

<return type="string">the entire text of the page</return>

<comment>Gets the entire text of the page.</comment>

</function>

<function name="getValue">

<return type="string">the element value, or "on/off" for checkbox/radio elements</return>

<param name="locator">an <a href="#locators">element locator</a></param>

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

</function>

<function name="getText">

<return type="string">the text of the element</return>

<param name="locator">an <a href="#locators">element locator</a></param>

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

</function>

<function name="highlight">

<param name="locator">an <a href="#locators">element locator</a></param>

<comment>Briefly changes the backgroundColor of the specified element yellow.  Useful for debugging.</comment>

</function>

<function name="getEval">

<return type="string">the results of evaluating the snippet</return>

<param name="script">the JavaScript snippet to run</param>

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

<p>Note that, by default, the snippet will run in the context of the "selenium"

object itself, so <code>this</code> will refer to the Selenium object, and <code>window</code> will

refer to the top-level runner test window, not the window of your application.</p>

<p>If you need a reference to the window of your application, you can refer

to <code>this.browserbot.getCurrentWindow()</code> and if you need to use

a locator to refer to a single element in your application page, you can

use <code>this.browserbot.findElement("foo")</code> where "foo" is your locator.</p></comment>

</function>

<function name="isChecked">

<return type="boolean">true if the checkbox is checked, false otherwise</return>

<param name="locator">an <a href="#locators">element locator</a> pointing to a checkbox or radio button</param>

<comment>Gets whether a toggle-button (checkbox/radio) is checked.  Fails if the specified element doesn't exist or isn't a toggle-button.</comment>

</function>

<function name="getTable">

<return type="string">the text from the specified cell</return>

<param name="tableCellAddress">a cell address, e.g. "foo.1.4"</param>

<comment>Gets the text from a cell of a table. The cellAddress syntax

tableLocator.row.column, where row and column start at 0.</comment>

</function>

<function name="getSelectedLabels">

<return type="string[]">an array of all selected option labels in the specified select drop-down</return>

<param name="selectLocator">an <a href="#locators">element locator</a> identifying a drop-down menu</param>

<comment>Gets all option labels (visible text) for selected options in the specified select or multi-select element.</comment>

</function>

<function name="getSelectedLabel">

<return type="string">the selected option label in the specified select drop-down</return>

<param name="selectLocator">an <a href="#locators">element locator</a> identifying a drop-down menu</param>

<comment>Gets option label (visible text) for selected option in the specified select element.</comment>

</function>

<function name="getSelectedValues">

<return type="string[]">an array of all selected option values in the specified select drop-down</return>

<param name="selectLocator">an <a href="#locators">element locator</a> identifying a drop-down menu</param>

<comment>Gets all option values (value attributes) for selected options in the specified select or multi-select element.</comment>

</function>

<function name="getSelectedValue">

<return type="string">the selected option value in the specified select drop-down</return>

<param name="selectLocator">an <a href="#locators">element locator</a> identifying a drop-down menu</param>

<comment>Gets option value (value attribute) for selected option in the specified select element.</comment>

</function>

<function name="getSelectedIndexes">

<return type="string[]">an array of all selected option indexes in the specified select drop-down</return>

<param name="selectLocator">an <a href="#locators">element locator</a> identifying a drop-down menu</param>

<comment>Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.</comment>

</function>

<function name="getSelectedIndex">

<return type="string">the selected option index in the specified select drop-down</return>

<param name="selectLocator">an <a href="#locators">element locator</a> identifying a drop-down menu</param>

<comment>Gets option index (option number, starting at 0) for selected option in the specified select element.</comment>

</function>

<function name="getSelectedIds">

<return type="string[]">an array of all selected option IDs in the specified select drop-down</return>

<param name="selectLocator">an <a href="#locators">element locator</a> identifying a drop-down menu</param>

<comment>Gets all option element IDs for selected options in the specified select or multi-select element.</comment>

</function>

<function name="getSelectedId">

<return type="string">the selected option ID in the specified select drop-down</return>

<param name="selectLocator">an <a href="#locators">element locator</a> identifying a drop-down menu</param>

<comment>Gets option element ID for selected option in the specified select element.</comment>

</function>

<function name="isSomethingSelected">

<return type="boolean">true if some option has been selected, false otherwise</return>

<param name="selectLocator">an <a href="#locators">element locator</a> identifying a drop-down menu</param>

<comment>Determines whether some option in a drop-down menu is selected.</comment>

</function>

<function name="getSelectOptions">

<return type="string[]">an array of all option labels in the specified select drop-down</return>

<param name="selectLocator">an <a href="#locators">element locator</a> identifying a drop-down menu</param>

<comment>Gets all option labels in the specified select drop-down.</comment>

</function>

<function name="getAttribute">

<return type="string">the value of the specified attribute</return>

<param name="attributeLocator">an element locator followed by an</param>

<comment>Gets the value of an element attribute.</comment>

</function>

<function name="isTextPresent">

<return type="boolean">true if the pattern matches the text, false otherwise</return>

<param name="pattern">a <a href="#patterns">pattern</a> to match with the text of the page</param>

<comment>Verifies that the specified text pattern appears somewhere on the rendered page shown to the user.</comment>

</function>

<function name="isElementPresent">

<return type="boolean">true if the element is present, false otherwise</return>

<param name="locator">an <a href="#locators">element locator</a></param>

<comment>Verifies that the specified element is somewhere on the page.</comment>

</function>

<function name="isVisible">

<return type="boolean">true if the specified element is visible, false otherwise</return>

<param name="locator">an <a href="#locators">element locator</a></param>

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

</function>

<function name="isEditable">

<return type="boolean">true if the input element is editable, false otherwise</return>

<param name="locator">an <a href="#locators">element locator</a></param>

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

</function>

<function name="getAllButtons">

<return type="string[]">the IDs of all buttons on the page</return>

<comment>Returns the IDs of all buttons on the page.

<p>If a given button has no ID, it will appear as "" in this array.</p></comment>

</function>

<function name="getAllLinks">

<return type="string[]">the IDs of all links on the page</return>

<comment>Returns the IDs of all links on the page.

<p>If a given link has no ID, it will appear as "" in this array.</p></comment>

</function>

<function name="getAllFields">

<return type="string[]">the IDs of all field on the page</return>

<comment>Returns the IDs of all input fields on the page.

<p>If a given field has no ID, it will appear as "" in this array.</p></comment>

</function>

<function name="getAttributeFromAllWindows">

<return type="string[]">the set of values of this attribute from all known windows.</return>

<param name="attributeName">name of an attribute on the windows</param>

<comment>Returns every instance of some attribute from all known windows.</comment>

</function>

<function name="dragdrop">

<param name="locator">an element locator</param>

<param name="movementsString">offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"</param>

<comment>deprecated - use dragAndDrop instead</comment>

</function>

<function name="setMouseSpeed">

<param name="pixels">the number of pixels between "mousemove" events</param>

<comment>Configure the number of pixels between "mousemove" events during dragAndDrop commands (default=10).

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

<p>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.</p></comment>

</function>

<function name="getMouseSpeed">

<return type="number">the number of pixels between "mousemove" events during dragAndDrop commands (default=10)</return>

<comment>Returns the number of pixels between "mousemove" events during dragAndDrop commands (default=10).</comment>

</function>

<function name="dragAndDrop">

<param name="locator">an element locator</param>

<param name="movementsString">offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"</param>

<comment>Drags an element a certain distance and then drops it</comment>

</function>

<function name="dragAndDropToObject">

<param name="locatorOfObjectToBeDragged">an element to be dragged</param>

<param name="locatorOfDragDestinationObject">an element whose location (i.e., whose center-most pixel) will be the point where locatorOfObjectToBeDragged  is dropped</param>

<comment>Drags an element and drops it on another element</comment>

</function>

<function name="windowFocus">

<param name="windowName">name of the window to be given focus</param>

<comment>Gives focus to a window</comment>

</function>

<function name="windowMaximize">

<param name="windowName">name of the window to be enlarged</param>

<comment>Resize window to take up the entire screen</comment>

</function>

<function name="getAllWindowIds">

<return type="string[]">the IDs of all windows that the browser knows about.</return>

<comment>Returns the IDs of all windows that the browser knows about.</comment>

</function>

<function name="getAllWindowNames">

<return type="string[]">the names of all windows that the browser knows about.</return>

<comment>Returns the names of all windows that the browser knows about.</comment>

</function>

<function name="getAllWindowTitles">

<return type="string[]">the titles of all windows that the browser knows about.</return>

<comment>Returns the titles of all windows that the browser knows about.</comment>

</function>

<function name="getHtmlSource">

<return type="string">the entire HTML source</return>

<comment>Returns the entire HTML source between the opening and

closing "html" tags.</comment>

</function>

<function name="setCursorPosition">

<param name="locator">an <a href="#locators">element locator</a> pointing to an input element or textarea</param>

<param name="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.</param>

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

</function>

<function name="getElementIndex">

<return type="number">of relative index of the element to its parent (starting from 0)</return>

<param name="locator">an <a href="#locators">element locator</a> pointing to an element</param>

<comment>Get the relative index of an element to its parent (starting from 0). The comment node and empty text node

will be ignored.</comment>

</function>

<function name="isOrdered">

<return type="boolean">true if two elements are ordered and have same parent, false otherwise</return>

<param name="locator1">an <a href="#locators">element locator</a> pointing to the first element</param>

<param name="locator2">an <a href="#locators">element locator</a> pointing to the second element</param>