selenium.lua

function self:doCommand( action, args )

Build the HTTP request will be sent to the server

Parameters

Returns

String server response

function split( str, pat )

splits a string on separator

Parameters

Returns

String

function self:getSession( action )

Get a Selenium Session

Parameters

action- String

Returns

String

function getBoolean( action, args )

Parameters

Returns

Boolean

function self:getNumber( action, args )

Parameters

Returns

Number

function self:getString( action, args )

Parameters

Returns

String

function self:start()

Run the browser and set session id.

Returns

Opens an URL in the test frame.  This accepts both relative and absolute URLs.  The “open” command waits for the page to load before proceeding, ie. the “AndWait” suffix is implicit.  Note : The URL must be on the same domain as the runner HTML due to security restrictions in the browser (Same Origin Policy).  If you need to open an URL on another domain, use the Selenium Server to start a new browser session on that domain.

Parameters

function self:stop()

Close the browser and set session id null.

function self:deleteAllVisibleCookies()

Calls deleteCookie with recurse=true on all cookies visible to the current page.  As noted on the documentation for deleteCookie, recurse=true can be much slower than simply deleting the cookies using a known domain/path.

function self:createCookie( nameValuePair, optionsString )

Create a new cookie whose path and domain are same with those of current page under test, unless you specified a path for this cookie explicitly.

Parameters

function self:isCookiePresent( name )

Parameters

Returns

true if a cookie with the specified name is present, or false otherwise.

function self:getCookieByName( name )

Parameters

Returns

function self:getCookie()

Returns

function self:attachFile( fieldLocator, fileLocator )

Sets a file input (upload) field to the file listed in fileLocator

Parameters

function self:captureScreenshot( filename )

Captures a PNG screenshot to the specified file.

Parameters

function self:captureScreenshotToString()

Capture a PNG screenshot.  It then returns the file as a base 64 encoded string.

Returns

function self:getSelectOptions( selectLocator )

Gets all option labels in the specified select drop-down.

Parameters

Returns

array an array of all option labels in the specified select drop-down

function self:getText( locator )

Gets the text of an element.  This works for any element that contains text.  This command uses either the textContent (Mozilla-like browsers) or the innerText (IE-like browsers) of the element, which is the rendered text shown to the user.

Parameters

Returns

function self:clickAt( locator, coordString )

Clicks on a link, button, checkbox or radio button.  If the click action causes a new page to load (like a link usually does), call waitForPageToLoad.

Parameters

function self:doubleClickAt( locator, coordString )

Doubleclicks on a link, button, checkbox or radio button.  If the action causes a new page to load (like a link usually does), call waitForPageToLoad.

Parameters

function self:contextMenuAt( locator, coordString )

Simulates opening the context menu for the specified element (as might happen if the user “right-clicked” on the element).

Parameters

function self:fireEvent( locator, eventName )

Explicitly simulate an event, to trigger the corresponding “onevent” handler.

Parameters

function self:keyPress( locator, keySequence )

Simulates a user pressing and releasing a key.

Parameters

Simulates a user releasing a key.

Parameters

function self:keyDownNative( keycode )

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.

Parameters

function self:keyUpNative( keycode )

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.

Parameters

function self:keyPressNative( keycode )

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.

Parameters

function self:rollup( rollupName, kwargs )

Executes a command rollup, which is a series of commands with a unique name, and optionally arguments that control the generation of the set of commands.  If any one of the rolled-up commands fails, the rollup is considered to have failed.  Rollups may also contain nested rollups.

Parameters

function self:addLocationStrategy( strategyName, functionDefinition )

Defines a new function for Selenium to locate elements on the page.  For example, if you define the strategy “foo”, and someone runs click(“foo=blah”), we’ll run your function, passing you the string “blah”, and click on the element that your function returns, or throw an “Element not found” error if your function returns null.  We’ll pass three arguments to your function:

• locator the string the user passed in
• inWindow the currently selected window
• inDocument the currently selected document

The function must return null if the element can’t be found.

Parameters

function self:ignoreAttributesWithoutValue( ignore )

Specifies whether Selenium will ignore xpath attributes that have no value, i.e. are the empty string, when using the non-native xpath evaluation engine.  You’d want to do this for performance reasons in IE.  However, this could break certain xpaths, for example an xpath that looks for an attribute whose value is NOT the empty string.  The hope is that such xpaths are relatively rare, but the user should have the option of using them.  Note that this only influences xpath evaluation when using the ajaxslt engine (i.e. not “javascript-xpath”).

Parameters

function self:isOrdered( locator1, locator2 )

Check if these two elements have same parent and are ordered siblings in the DOM.  Two same elements will not be considered ordered.

Parameters

Returns

boolean true if element1 is the previous sibling of element2, false otherwise

function self:mouseDown( locator )

Simulates a user pressing the right mouse button (without releasing it yet) at the specified location.

Parameters

Simulates a user pressing the right mouse button (without releasing it yet) on the specified element.

Parameters

function self:mouseDownAt( locator, coordString )

Simulates a user pressing the left mouse button (without releasing it yet) at the specified location.

Parameters

function self:mouseDownRightAt( locator, coordString )

Simulates a user pressing the right mouse button (without releasing it yet) at the specified location.

Parameters

function self:mouseUp( locator )

Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) on the specified element.

Parameters

function self:mouseUpRight( locator )

Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) on the specified element.

Parameters

function self:mouseUpAt( locator, coordString )

Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) at the specified location.

Parameters

function self:mouseUpRightAt( locator, coordString )

Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) at the specified location.

Parameters

function self:mouseMove( locator )

Simulates a user pressing the mouse button (without releasing it yet) on the specified element.

Parameters

function self:mouseMoveAt( locator, coordString )

Simulates a user pressing the mouse button (without releasing it yet) on the specified element.

Parameters

function self:mouseOver( locator )

Simulates a user hovering a mouse over the specified element.

Parameters

function self:mouseOut( locator )

Simulates a user moving the mouse pointer away from the specified element.

Parameters

function self:type( locator, value )

Sets the value of an input field, as though you d it in.  Can also be used to set the value of combo boxes, check boxes, etc.  In these cases, value should be the value of the option selected, not the visible text.

Parameters

function self:typeKeys( locator, value )

Simulates keystroke events on the specified element, as though you typed the value key-by-key.  This is a convenience method for calling keyDown, keyUp, keyPress for every character in the specified string-- this is useful for dynamic UI widgets (like auto-completing combo boxes) that require explicit key events.  Unlike the simple “type” command, which forces the specified value into the page directly, this command may or may not have any visible effect, even in cases where typing keys would normally have a visible effect.  For example, if you use “typeKeys” on a form element, you may or may not see the results of what you typed in the field.  In some cases, you may need to use the simple “type” command to set the value of the field and then the “typeKeys” command to send the keystroke events corresponding to what you just typed.

Parameters

function self:setSpeed( value )

Set execution speed (i.e., set the millisecond length of a delay which will follow each selenium operation).  By default, there is no such delay, i.e., the delay is 0 milliseconds.

Parameters

function self:getSpeed()

Get execution speed (i.e., get the millisecond length of the delay following each selenium operation).  By default, there is no such delay, i.e., the delay is 0 milliseconds.

See Also

setSpeed.

Returns

string the execution speed in milliseconds.

function self:check( locator )

Check a toggle-button (checkbox/radio)

Parameters

function self:uncheck( locator )

Uncheck a toggle-button (checkbox/radio)

Parameters

function self:select( 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.  -label =labelPattern:

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

• label = regexp:^[Oo]ther
• value = valuePattern:

matches options based on their values.

• value = other
• id = id:

matches options based on their ids.

• id=option1
• index = index:

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

• index=2

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

Parameters

function self:removeSelection( locator, optionLocator )

Remove a selection from the set of selected options in a multi-select element using an option locator.

Parameters

function self:removeAllSelections( locator )

Unselects all of the selected options in a multi-select element.

Parameters

function self:submit( formLocator )

Submit the specified form.  This is particularly useful for forms without submit buttons, e.g. single-input “Search” forms.

Parameters

function self:openWindow( Url, windowID )

Opens a popup window (if a window with that ID isn’t already open).  After opening the window, you’ll need to select it using the selectWindow command.  This command can also be a useful workaround for bug SEL-339.  In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the “onLoad” event, for example).  In those cases, you can force Selenium to notice the open window’s name by using the Selenium openWindow command, using an empty (blank) url, like this: openWindow(“”, “myFunnyWindow”).

Parameters

function self:selectWindow( windowID )

Selects a popup window using a window locator-- once a popup window has been selected, all commands go to that window.  To select the main window again, use null as the target.  Window locators provide different ways of specifying the window object: by title, by internal JavaScript ”name,” or by JavaScript variable.

• title = My Special Window:

Finds the window using the text that appears in the title bar.  Be careful-- two windows can share the same title.  If that happens, this locator will just pick one.

• name = myWindow:

Finds the window using its internal JavaScript “name” property.  This is the second parameter “windowName” passed to the JavaScript method window.open(url, windowName, windowFeatures, replaceFlag) (which Selenium intercepts).

• var = variableName:

Some pop-up windows are unnamed (anonymous), but are associated with a JavaScript variable name in the current application window, e.g.  *”window.foo = window.open(url)--”*.  In those cases, you can open the window using ”var=foo” If no window locator prefix is provided, we’ll try to guess what you mean like this: 1) if windowID is null, (or the string “null” then it is assumed the user is referring to the original window instantiated by the browser).  2) if the value of the “windowID” parameter is a JavaScript variable name in the current application window, then it is assumed that this variable contains the return value from a call to the JavaScript window.open() method.  3) Otherwise, selenium looks in a hash it maintains that maps string names to window “names”.  4) If that fails, we’ll try looping over all of the known windows to try to find the appropriate “title”.  Since “title” is not necessarily unique, this may have unexpected behavior.  If you’re having trouble figuring out the name of a window that you want to manipulate, look at the Selenium log messages which identify the names of windows created via window.open (and therefore intercepted by Selenium).  You will see messages like the following for each window as it is opened: debug: window.open call intercepted-- window ID (which you can use with selectWindow()) is “myNewWindow” In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the “onLoad” event, for example).  (This is bug SEL-339.)  In those cases, you can force Selenium to notice the open window’s name by using the Selenium openWindow command, using an empty (blank) url, like this: openWindow(“”, “myFunnyWindow”).

Parameters

function self:selectPopUp( windowID )

Simplifies the process of selecting a popup window (and does not offer functionality beyond what selectWindow() already provides).  If window is either not specified, or specified as “null”, the first non-top window is selected.  The top window is the one that would be selected by selectWindow() without providing a windowID . This should not be used when more than one popup window is in play.  Otherwise, the window will be looked up considering windowID as the following in order: 1) the “name” of the window, as specified to window.open() 2) a javascript variable which is a reference to a window 3) the title of the window.  This is the same ordered lookup performed by selectWindow.

Parameters

function self:deselectPopUp()

Selects the main window. functionally equivalent to using selectWindow() and specifying no value for windowID.

function self:selectFrame( locator )

Selects a frame within the current window.  (You may invoke this command multiple times to select nested frames.)  To select the parent frame, use “relative=parent” as a locator-- to select the top frame, use “relative=top”.  You can also select a frame by its 0-based index number-- select the first frame with “index=0”, or the third frame with “index=2”.  You may also use a DOM expression to identify the frame you want directly, like this: dom=frames[“main”].frames[“subframe”]

Parameters

function self:getWhetherThisFrameMatchFrameExpression( currentFrameString, target )

Determine whether current/locator identify the frame containing this running code.  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.

Parameters currentFrameString - String starting frame target - String New frame (which might be relative to the current one)

Returns

boolean true if the New frame is this code--s window

function self:getWhetherThisWindowMatchWindowExpression( currentWindowString, target )

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

Parameters

Returns

boolean true if the New window is this code--s window

function self:waitForPopUp( windowID, Timeout )

Waits for a popup window to appear and load up.

Parameters

function self:chooseCancelOnNextConfirmation()

By default, Selenium’s overridden window.confirm() function will return true, as if the user had manually clicked OK-- after running this command, the next call to confirm() will return false, as if the user had clicked Cancel.  Selenium will then resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call this command for each confirmation.  Take note - every time a confirmation comes up, you must consume it with a corresponding getConfirmation, or else the next selenium operation will fail.

function self:chooseOkOnNextConfirmation()

Undo the effect of calling chooseCancelOnNextConfirmation.  Note that Selenium’s overridden window.confirm() function will normally automatically return true, as if the user had manually clicked OK, so you shouldn’t need to use this command unless for some reason you need to change your mind prior to the next confirmation.  After any confirmation, Selenium will resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call chooseCancelOnNextConfirmation for each confirmation.  Take note - every time a confirmation comes up, you must consume it with a corresponding getConfirmation, or else the next selenium operation will fail.

function self:answerOnNextPrompt( answer )

Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()].

Parameters

function self:close()

Simulates the user clicking the “close” button in the titlebar of a popup window or tab.

function self:isAlertPresent()

Has an alert occurred?  This function never throws an exception

Returns

boolean true if there is an alert

function self:isPromptPresent()

Has a prompt occurred?  This function never throws an exception

Returns

boolean true if there is a pending p

function self:isChecked( locator )

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

Parameters

Returns

boolean true if the checkbox is checked, false otherwise

function self:getTable( tableCellAddress )

Gets the text from a cell of a table.  The cellAddress syntax tableLocator.row.column, where row and column start at 0.

Parameters

Returns

string the text from the specified cell

function self:getSelectedLabels( selectLocator )

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

Parameters

Returns

array an array of all selected option labels in the specified select drop-down

function self:getSelectedLabel( selectLocator )

Gets option label (visible text) for selected option in the specified select element.

Parameters

Returns

string the selected option label in the specified select drop-down

function self:getSelectedValue( selectLocator )

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

Parameters

returns array an array of all selected option values in the specified select drop-down

function self:getSelectedIndexes( selectLocator )

Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element. selectLocator an element locator identifying a drop-down menu @return array an array of all selected option indexes in the specified select drop-down

function self:getSelectedIndex( selectLocator )

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

Parameters

Returns

string the selected option index in the specified select drop-down

function self:getSelectedIds( selectLocator )

Gets all option element IDs for selected options in the specified select or multi-select element. selectLocator an element locator identifying a drop-down menu @return array an array of all selected option IDs in the specified select drop-down

function self:getSelectedId( selectLocator )

Gets option element ID for selected option in the specified select element.

Parameters

Returns

string the selected option ID in the specified select drop-down

function self:isSomethingSelected( selectLocator )

Determines whether some option in a drop-down menu is selected.

Parameters

Returns

boolean true if some option has been selected, false otherwise

function self:getAttribute( attributeLocator )

Gets the value of an element attribute.  The value of the attribute may differ across browsers (this is the case for the “style” attribute, for example).

Parameters

Returns

string the value of the specified attribute

function self:getAlert()

Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts.  Getting an alert has the same effect as manually clicking OK.  If an alert is generated but you do not consume it with getAlert, the next Selenium action will fail.  Under Selenium, JavaScript alerts will NOT pop up a visible alert dialog.  Selenium does NOT support JavaScript alerts that are generated in a page’s onload() event handler.  In this case a visible dialog WILL be generated and Selenium will hang until someone manually clicks OK.

Returns

string The message of the most recent JavaScript alert

function self:getEval( script )

Gets the result of evaluating the specified JavaScript snippet.  The snippet may have multiple lines, but only the result of the last line will be returned.  Note that, by default, the snippet will run in the context of the “selenium” object itself, so this will refer to the Selenium object.  Use window to refer to the window of your application, e.g.  window.document.getElementById(‘foo’) If you need to use a locator to refer to a single element in your application page, you can use this.browserbot.findElement(“id=foo”) where “id=foo” is your locator.

Parameters

Returns

string the results of evaluating the snippet

function self:getConfirmation()

Retrieves the message of a JavaScript confirmation dialog generated during the previous action.  By default, the confirm function will return true, having the same effect as manually clicking OK.  This can be changed by prior execution of the chooseCancelOnNextConfirmation command.  If an confirmation is generated but you do not consume it with getConfirmation, the next Selenium action will fail.  NOTE: under Selenium, JavaScript confirmations will NOT pop up a visible dialog.  NOTE: Selenium does NOT support JavaScript confirmations that are generated in a page’s onload() event handler.  In this case a visible dialog WILL be generated and Selenium will hang until you manually click OK.

Returns string the message of the most recent JavaScript confirmation dialog

function self:getBodyText()

Gets the entire text of the page.

Returns

string the entire text of the page

function self:metaKeyDown()

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

function self:metaKeyUp()

Release the meta key.

function self:shiftKeyDown()

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

function self:shiftKeyUp()

Release the shift key.

function self:altKeyDown()

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

function self:altKeyUp()

Release the alt key.

function self:controlKeyDown()

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

function self:controlKeyUp()

Release the control key.

function self:waitForFrameToLoad( frameAddress, Timeout )

Waits for a new frame to load.  Selenium constantly keeps track of new pages and frames loading, and sets a “newPageLoaded” flag when it first notices a page load.

See Also

<_waitForPageToLoad>

Parameters

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

function self:windowMaximize()

Resize currently selected window to take up the entire screen

function self:windowFocus()

Gives focus to the currently selected window

function self:dragAndDropToObject( locatorOfObjectToBeDragged, locatorOfDragDestinationObject )

Drags an element and drops it on another element

Parameters

function self:dragAndDrop( locator, movementsString )

Drags an element a certain distance and then drops it

Parameters

function self:getMouseSpeed()

returns the number of pixels between “mousemove” events during dragAndDrop commands (default=10).

Returns

function self:setMouseSpeed( pixels )

Configure the number of pixels between “mousemove” events during dragAndDrop commands (default=10).  Setting this value to 0 means that we’ll send a “mousemove” event to every single pixel in between the start location and the end location-- that can be very slow, and may cause some browsers to force the JavaScript to timeout.  If the mouse speed is greater than the distance between the two dragged objects, we’ll just send one “mousemove” at the start location and then one final one at the end location.

Parameters

function self:getHtmlSource()

returns the entire HTML source between the opening and closing “html” tags.

Returns

string the entire HTML source

function self:setCursorPosition( 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.

Parameters

function self:getElementIndex( locator )

Get the relative index of an element to its parent (starting from 0).  The comment node and empty text node will be ignored. locator an element locator pointing to an element @return number of relative index of the element to its parent (starting from 0)

function self:getElementPositionLeft( locator )

Retrieves the horizontal position of an element

Parameters

locator an element locator pointing to an element OR an element itself

Returns

number of pixels from the edge of the frame.

function self:getElementPositionTop( locator )

Retrieves the vertical position of an element

Parameters

Returns

number of pixels from the edge of the frame.

function self:getElementWidth( locator )

Retrieves the width of an element

Parameters

locator an element locator pointing to an element

Returns

number width of an element in pixels

function self:getElementHeight( locator )

Retrieves the height of an element

Parameters

Returns

number height of an element in pixels

function self:getCursorPosition( 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.

Parameters

Returns

number the numerical position of the cursor in the field

function self:getXpathCount( xpath )

returns the number of nodes that match the specified xpath, eg.  “//table” would give the number of tables.

Parameters

Returns

number the number of nodes that match the specified xpath

function self:useXpathLibrary( libraryName )

Allows choice of one of the available libraries.

Parameters

-If libraryName isn’t one of these three, then no change will be made.

Returns

number

function self:assignId( locator, identifier )

Temporarily sets the “id” attribute of the specified element, so you can locate it in the future using its ID rather than a slow/complicated XPath.  This ID will disappear once the page is reloaded.

Parameters

Returns

number

function self:allowNativeXpath( allow )

Specifies whether Selenium should use the native in-browser implementation of XPath (if any native version is available)-- if you pass “false” to this function, we will always use our pure-JavaScript xpath library.  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.

Parameters

function self:getAllWindowTitles()

returns the titles of all windows that the browser knows about in an array.

Returns

Array of titles of all windows that the browser knows about.

function self:getAllWindowNames()

returns the names of all windows that the browser knows about in an array.

Returns

array Array of names of all windows that the browser knows about.

function self:getAllWindowIds()

returns the IDs of all windows that the browser knows about in an array.

Returns

array Array of identifiers of all windows that the browser knows about.

function self:getAllFields()

returns the IDs of all input fields on the page.  If a given field has no ID, it will appear as “” in this array.

Returns

array the IDs of all field on the page

function self:getAllLinks()

returns the IDs of all links on the page.  If a given link has no ID, it will appear as “” in this array.

Returns

array the IDs of all links on the page

function self:getAllButtons()

returns the IDs of all buttons on the page.  If a given button has no ID, it will appear as “” in this array.

Returns

array the IDs of all buttons on the page

function self:setTimeout( Timeout )

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.

Parameters

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

function self:goBack()

Simulates the user clicking the “back” button on their browser.

function self:highlight( locator )

riefly changes the backgroundColor of the specified element yellow.  Useful for debugging.

Parameters

function self:refresh()

Simulates the user clicking the “Refresh” button on their browser.

function self:isEditable( locator )

Determines whether the specified input element is editable, ie hasn’t been disabled.  This method will fail if the specified element isn’t an input element.

Parameters

Returns

boolean true if the input element is editable, false otherwise

function self:isTextPresent( pattern )

Verifies that the specified text pattern appears somewhere on the rendered page shown to the user.

Parameters

Returns

boolean true if the pattern matches the text, false otherwise

function self:isElementPresent( locator )

Verifies that the specified element is somewhere on the page.

Parameters

Returns

boolean true if the element is present, false otherwise

function self:setBrowserLogLevel( logLevel )

Sets the threshold for browser-side logging messages-- log messages beneath this threshold will be discarded.  Valid logLevel strings are: “debug”, “info”, “warn”, “error” or “off”.  To see the browser logs, you need to either show the log window in GUI mode, or enable browser-side logging in Selenium RC.

Parameters

function self:setContext( context )

Writes a message to the status bar and adds a note to the browser-side log.

Parameters

function self:retrieveLastRemoteControlLogs()

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.

Returns

string The last N log messages as a multi-line string.

function self:shutDownSeleniumServer()

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.