com.thoughtworks.selenium
Class DefaultSelenium

java.lang.Object
  com.thoughtworks.selenium.DefaultSelenium

All Implemented Interfaces:

Selenium

public class DefaultSelenium
extends java.lang.Object
implements Selenium

The default implementation of the Selenium interface; end users will primarily interact with this object.

Field Summary

protected CommandProcessor

commandProcessor

Constructor Summary

DefaultSelenium(CommandProcessor processor)
Uses an arbitrary CommandProcessor

DefaultSelenium(java.lang.String serverHost, int serverPort, java.lang.String browserStartCommand, java.lang.String browserURL)
Uses a CommandBridgeClient, specifying a server host/port, a command to launch the browser, and a starting URL for the browser.

Method Summary

void	addSelection(java.lang.String locator, java.lang.String optionLocator) Add a selection to the set of selected options in a multi-select element using an option locator.
void	altKeyDown() Press the alt key and hold it down until doAltUp() is called or a new page is loaded.
void	altKeyUp() Release the alt key.
void	answerOnNextPrompt(java.lang.String answer) Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()].
void	check(java.lang.String locator) Check a toggle-button (checkbox/radio)
void	chooseCancelOnNextConfirmation() By default, Selenium's overridden window.confirm() function will return true, as if the user had manually clicked OK.
void	click(java.lang.String locator) Clicks on a link, button, checkbox or radio button.
void	clickAt(java.lang.String locator, java.lang.String coordString) Clicks on a link, button, checkbox or radio button.
void	close() Simulates the user clicking the "close" button in the titlebar of a popup window or tab.
void	controlKeyDown() Press the control key and hold it down until doControlUp() is called or a new page is loaded.
void	controlKeyUp() Release the control key.
void	createCookie(java.lang.String nameValuePair, java.lang.String optionsString) Create a new cookie whose path and domain are same with those of current page under test, unless you specified a path for this cookie explicitly.
void	deleteCookie(java.lang.String name, java.lang.String path) Delete a named cookie with specified path.
void	doubleClick(java.lang.String locator) Double clicks on a link, button, checkbox or radio button.
void	doubleClickAt(java.lang.String locator, java.lang.String coordString) Doubleclicks on a link, button, checkbox or radio button.
void	dragAndDrop(java.lang.String locator, java.lang.String movementsString) Drags an element a certain distance and then drops it
void	dragAndDropToObject(java.lang.String locatorOfObjectToBeDragged, java.lang.String locatorOfDragDestinationObject) Drags an element and drops it on another element
void	dragdrop(java.lang.String locator, java.lang.String movementsString) deprecated - use dragAndDrop instead
void	fireEvent(java.lang.String locator, java.lang.String eventName) Explicitly simulate an event, to trigger the corresponding "onevent" handler.
java.lang.String	getAlert() Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts.
java.lang.String[]	getAllButtons() Returns the IDs of all buttons on the page.
java.lang.String[]	getAllFields() Returns the IDs of all input fields on the page.
java.lang.String[]	getAllLinks() Returns the IDs of all links on the page.
java.lang.String[]	getAllWindowIds() Returns the IDs of all windows that the browser knows about.
java.lang.String[]	getAllWindowNames() Returns the names of all windows that the browser knows about.
java.lang.String[]	getAllWindowTitles() Returns the titles of all windows that the browser knows about.
java.lang.String	getAttribute(java.lang.String attributeLocator) Gets the value of an element attribute.
java.lang.String[]	getAttributeFromAllWindows(java.lang.String attributeName) Returns every instance of some attribute from all known windows.
java.lang.String	getBodyText() Gets the entire text of the page.
java.lang.String	getConfirmation() Retrieves the message of a JavaScript confirmation dialog generated during the previous action.
java.lang.String	getCookie() Return all cookies of the current page under test.
java.lang.Number	getCursorPosition(java.lang.String locator) Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers.
java.lang.Number	getElementHeight(java.lang.String locator) Retrieves the height of an element
java.lang.Number	getElementIndex(java.lang.String locator) Get the relative index of an element to its parent (starting from 0).
java.lang.Number	getElementPositionLeft(java.lang.String locator) Retrieves the horizontal position of an element
java.lang.Number	getElementPositionTop(java.lang.String locator) Retrieves the vertical position of an element
java.lang.Number	getElementWidth(java.lang.String locator) Retrieves the width of an element
java.lang.String	getEval(java.lang.String script) Gets the result of evaluating the specified JavaScript snippet.
java.lang.String	getExpression(java.lang.String expression) Returns the specified expression.
java.lang.String	getHtmlSource() Returns the entire HTML source between the opening and closing "html" tags.
java.lang.String	getLocation() Gets the absolute URL of the current page.
java.lang.String	getLogMessages() Return the contents of the log.
java.lang.String	getPrompt() Retrieves the message of a JavaScript question prompt dialog generated during the previous action.
java.lang.String	getSelectedId(java.lang.String selectLocator) Gets option element ID for selected option in the specified select element.
java.lang.String[]	getSelectedIds(java.lang.String selectLocator) Gets all option element IDs for selected options in the specified select or multi-select element.
java.lang.String	getSelectedIndex(java.lang.String selectLocator) Gets option index (option number, starting at 0) for selected option in the specified select element.
java.lang.String[]	getSelectedIndexes(java.lang.String selectLocator) Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.
java.lang.String	getSelectedLabel(java.lang.String selectLocator) Gets option label (visible text) for selected option in the specified select element.
java.lang.String[]	getSelectedLabels(java.lang.String selectLocator) Gets all option labels (visible text) for selected options in the specified select or multi-select element.
java.lang.String	getSelectedValue(java.lang.String selectLocator) Gets option value (value attribute) for selected option in the specified select element.
java.lang.String[]	getSelectedValues(java.lang.String selectLocator) Gets all option values (value attributes) for selected options in the specified select or multi-select element.
java.lang.String[]	getSelectOptions(java.lang.String selectLocator) Gets all option labels in the specified select drop-down.
void	getSpeed() Get execution speed (i.e., get the millisecond length of the delay following each selenium operation).
java.lang.String	getTable(java.lang.String tableCellAddress) Gets the text from a cell of a table.
java.lang.String	getText(java.lang.String locator) Gets the text of an element.
java.lang.String	getTitle() Gets the title of the current page.
java.lang.String	getValue(java.lang.String locator) Gets the (whitespace-trimmed) value of an input field (or anything else with a value parameter).
boolean	getWhetherThisFrameMatchFrameExpression(java.lang.String currentFrameString, java.lang.String target) Determine whether current/locator identify the frame containing this running code.
boolean	getWhetherThisWindowMatchWindowExpression(java.lang.String currentWindowString, java.lang.String target) Determine whether currentWindowString plus target identify the window containing this running code.
void	goBack() Simulates the user clicking the "back" button on their browser.
boolean	isAlertPresent() Has an alert occurred?
boolean	isChecked(java.lang.String locator) Gets whether a toggle-button (checkbox/radio) is checked.
boolean	isConfirmationPresent() Has confirm() been called?
boolean	isEditable(java.lang.String locator) Determines whether the specified input element is editable, ie hasn't been disabled.
boolean	isElementPresent(java.lang.String locator) Verifies that the specified element is somewhere on the page.
boolean	isOrdered(java.lang.String locator1, java.lang.String locator2) Check if these two elements have same parent and are ordered.
boolean	isPromptPresent() Has a prompt occurred?
boolean	isSomethingSelected(java.lang.String selectLocator) Determines whether some option in a drop-down menu is selected.
boolean	isTextPresent(java.lang.String pattern) Verifies that the specified text pattern appears somewhere on the rendered page shown to the user.
boolean	isVisible(java.lang.String locator) Determines if the specified element is visible.
void	keyDown(java.lang.String locator, java.lang.String keySequence) Simulates a user pressing a key (without releasing it yet).
void	keyPress(java.lang.String locator, java.lang.String keySequence) Simulates a user pressing and releasing a key.
void	keyUp(java.lang.String locator, java.lang.String keySequence) Simulates a user releasing a key.
void	metaKeyDown() Press the meta key and hold it down until doMetaUp() is called or a new page is loaded.
void	metaKeyUp() Release the meta key.
void	mouseDown(java.lang.String locator) Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
void	mouseDownAt(java.lang.String locator, java.lang.String coordString) Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
void	mouseMove(java.lang.String locator) Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
void	mouseMoveAt(java.lang.String locator, java.lang.String coordString) Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
void	mouseOut(java.lang.String locator) Simulates a user moving the mouse pointer away from the specified element.
void	mouseOver(java.lang.String locator) Simulates a user hovering a mouse over the specified element.
void	mouseUp(java.lang.String locator) Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
void	mouseUpAt(java.lang.String locator, java.lang.String coordString) Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
void	open(java.lang.String url) Opens an URL in the test frame.
void	openWindow(java.lang.String url, java.lang.String windowID) Opens a popup window (if a window with that ID isn't already open).
void	refresh() Simulates the user clicking the "Refresh" button on their browser.
void	removeSelection(java.lang.String locator, java.lang.String optionLocator) Remove a selection from the set of selected options in a multi-select element using an option locator.
void	select(java.lang.String selectLocator, java.lang.String optionLocator) Select an option from a drop-down using an option locator.
void	selectFrame(java.lang.String locator) Selects a frame within the current window.
void	selectWindow(java.lang.String windowID) Selects a popup window; once a popup window has been selected, all commands go to that window.
void	setContext(java.lang.String context, java.lang.String logLevelThreshold) Writes a message to the status bar and adds a note to the browser-side log.
void	setCursorPosition(java.lang.String locator, java.lang.String position) Moves the text cursor to the specified position in the given input element or textarea.
void	setSpeed(java.lang.String value) Set execution speed (i.e., set the millisecond length of a delay which will follow each selenium operation).
void	setTimeout(java.lang.String timeout) Specifies the amount of time that Selenium will wait for actions to complete.
void	shiftKeyDown() Press the shift key and hold it down until doShiftUp() is called or a new page is loaded.
void	shiftKeyUp() Release the shift key.
void	start() Launches the browser with a new Selenium session
void	stop() Ends the test session, killing the browser
void	submit(java.lang.String formLocator) Submit the specified form.
void	type(java.lang.String locator, java.lang.String value) Sets the value of an input field, as though you typed it in.
void	uncheck(java.lang.String locator) Uncheck a toggle-button (checkbox/radio)
void	waitForCondition(java.lang.String script, java.lang.String timeout) Runs the specified JavaScript snippet repeatedly until it evaluates to "true".
void	waitForPageToLoad(java.lang.String timeout) Waits for a new page to load.
void	waitForPopUp(java.lang.String windowID, java.lang.String timeout) Waits for a popup window to appear and load up.
void	windowFocus(java.lang.String windowName) Gives focus to a window
void	windowMaximize(java.lang.String windowName) Resize window to take up the entire screen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

commandProcessor

protected CommandProcessor commandProcessor

Constructor Detail

DefaultSelenium

public DefaultSelenium(java.lang.String serverHost,
                       int serverPort,
                       java.lang.String browserStartCommand,
                       java.lang.String browserURL)

Uses a CommandBridgeClient, specifying a server host/port, a command to launch the browser, and a starting URL for the browser.

browserString may be any one of the following:

• *firefox [absolute path] - Automatically launch a new Firefox process using a custom Firefox profile. This profile will be automatically configured to use the Selenium Server as a proxy and to have all annoying prompts ("save your password?" "forms are insecure" "make Firefox your default browser?" disabled. You may optionally specify an absolute path to your firefox executable, or just say "*firefox". If no absolute path is specified, we'll look for firefox.exe in a default location (normally c:\program files\mozilla firefox\firefox.exe), which you can override by setting the Java system property firefoxDefaultPath to the correct path to Firefox.
• *iexplore [absolute path] - Automatically launch a new Internet Explorer process using custom Windows registry settings. This process will be automatically configured to use the Selenium Server as a proxy and to have all annoying prompts ("save your password?" "forms are insecure" "make Firefox your default browser?" disabled. You may optionally specify an absolute path to your iexplore executable, or just say "*iexplore". If no absolute path is specified, we'll look for iexplore.exe in a default location (normally c:\program files\internet explorer\iexplore.exe), which you can override by setting the Java system property iexploreDefaultPath to the correct path to Internet Explorer.
• /path/to/my/browser [other arguments] - You may also simply specify the absolute path to your browser executable, or use a relative path to your executable (which we'll try to find on your path). Warning: If you specify your own custom browser, it's up to you to configure it correctly. At a minimum, you'll need to configure your browser to use the Selenium Server as a proxy, and disable all browser-specific prompting.

Parameters:

serverHost - the host name on which the Selenium Server resides

serverPort - the port on which the Selenium Server is listening

browserString - the command string used to launch the browser, e.g. "*firefox", "*iexplore" or "c:\\program files\\internet explorer\\iexplore.exe"

browserURL - the starting URL including just a domain name. We'll start the browser pointing at the Selenium resources on this URL, e.g. "http://www.google.com" would send the browser to "http://www.google.com/selenium-server/SeleneseRunner.html"

DefaultSelenium

public DefaultSelenium(CommandProcessor processor)

Uses an arbitrary CommandProcessor

Method Detail

start

public void start()

Description copied from interface: Selenium

Launches the browser with a new Selenium session

Specified by:

start in interface Selenium

stop

public void stop()

Description copied from interface: Selenium

Ends the test session, killing the browser

Specified by:

stop in interface Selenium

click

public void click(java.lang.String locator)

Description copied from interface: Selenium

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.

Specified by:

click in interface Selenium

Parameters:

locator - an element locator

doubleClick

public void doubleClick(java.lang.String locator)

Description copied from interface: Selenium

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.

Specified by:

doubleClick in interface Selenium

Parameters:

locator - an element locator

clickAt

public void clickAt(java.lang.String locator,
                    java.lang.String coordString)

Description copied from interface: Selenium

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.

Specified by:

clickAt in interface Selenium

Parameters:

locator - an element locator

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

doubleClickAt

public void doubleClickAt(java.lang.String locator,
                          java.lang.String coordString)

Description copied from interface: Selenium

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.

Specified by:

doubleClickAt in interface Selenium

Parameters:

locator - an element locator

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

fireEvent

public void fireEvent(java.lang.String locator,
                      java.lang.String eventName)

Description copied from interface: Selenium

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

Specified by:

fireEvent in interface Selenium

Parameters:

locator - an element locator

eventName - the event name, e.g. "focus" or "blur"

keyPress

public void keyPress(java.lang.String locator,
                     java.lang.String keySequence)

Description copied from interface: Selenium

Simulates a user pressing and releasing a key.

Specified by:

keyPress in interface Selenium

Parameters:

locator - an element locator

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

shiftKeyDown

public void shiftKeyDown()

Description copied from interface: Selenium

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

Specified by:

shiftKeyDown in interface Selenium

shiftKeyUp

public void shiftKeyUp()

Description copied from interface: Selenium

Release the shift key.

Specified by:

shiftKeyUp in interface Selenium

metaKeyDown

public void metaKeyDown()

Description copied from interface: Selenium

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

Specified by:

metaKeyDown in interface Selenium

metaKeyUp

public void metaKeyUp()

Description copied from interface: Selenium

Release the meta key.

Specified by:

metaKeyUp in interface Selenium

altKeyDown

public void altKeyDown()

Description copied from interface: Selenium

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

Specified by:

altKeyDown in interface Selenium

altKeyUp

public void altKeyUp()

Description copied from interface: Selenium

Release the alt key.

Specified by:

altKeyUp in interface Selenium

controlKeyDown

public void controlKeyDown()

Description copied from interface: Selenium

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

Specified by:

controlKeyDown in interface Selenium

controlKeyUp

public void controlKeyUp()

Description copied from interface: Selenium

Release the control key.

Specified by:

controlKeyUp in interface Selenium

keyDown

public void keyDown(java.lang.String locator,
                    java.lang.String keySequence)

Description copied from interface: Selenium

Simulates a user pressing a key (without releasing it yet).

Specified by:

keyDown in interface Selenium

Parameters:

locator - an element locator

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

keyUp

public void keyUp(java.lang.String locator,
                  java.lang.String keySequence)

Description copied from interface: Selenium

Simulates a user releasing a key.

Specified by:

keyUp in interface Selenium

Parameters:

locator - an element locator

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

mouseOver

public void mouseOver(java.lang.String locator)

Description copied from interface: Selenium

Simulates a user hovering a mouse over the specified element.

Specified by:

mouseOver in interface Selenium

Parameters:

locator - an element locator

mouseOut

public void mouseOut(java.lang.String locator)

Description copied from interface: Selenium

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

Specified by:

mouseOut in interface Selenium

Parameters:

locator - an element locator

mouseDown

public void mouseDown(java.lang.String locator)

Description copied from interface: Selenium

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

Specified by:

mouseDown in interface Selenium

Parameters:

locator - an element locator

mouseDownAt

public void mouseDownAt(java.lang.String locator,
                        java.lang.String coordString)

Description copied from interface: Selenium

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

Specified by:

mouseDownAt in interface Selenium

Parameters:

locator - an element locator

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

mouseUp

public void mouseUp(java.lang.String locator)

Description copied from interface: Selenium

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

Specified by:

mouseUp in interface Selenium

Parameters:

locator - an element locator

mouseUpAt

public void mouseUpAt(java.lang.String locator,
                      java.lang.String coordString)

Description copied from interface: Selenium

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

Specified by:

mouseUpAt in interface Selenium

Parameters:

locator - an element locator

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

mouseMove

public void mouseMove(java.lang.String locator)

Description copied from interface: Selenium

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

Specified by:

mouseMove in interface Selenium

Parameters:

locator - an element locator

mouseMoveAt

public void mouseMoveAt(java.lang.String locator,
                        java.lang.String coordString)

Description copied from interface: Selenium

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

Specified by:

mouseMoveAt in interface Selenium

Parameters:

locator - an element locator

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

type

public void type(java.lang.String locator,
                 java.lang.String value)

Description copied from interface: Selenium

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.

Specified by:

type in interface Selenium

Parameters:

locator - an element locator

value - the value to type

setSpeed

public void setSpeed(java.lang.String value)

Description copied from interface: Selenium

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.

Specified by:

setSpeed in interface Selenium

Parameters:

value - the number of milliseconds to pause after operation

getSpeed

public void getSpeed()

Description copied from interface: Selenium

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.

Specified by:

getSpeed in interface Selenium

check

public void check(java.lang.String locator)

Description copied from interface: Selenium

Check a toggle-button (checkbox/radio)

Specified by:

check in interface Selenium

Parameters:

locator - an element locator

uncheck

public void uncheck(java.lang.String locator)

Description copied from interface: Selenium

Uncheck a toggle-button (checkbox/radio)

Specified by:

uncheck in interface Selenium

Parameters:

locator - an element locator

select

public void select(java.lang.String selectLocator,
                   java.lang.String optionLocator)

Description copied from interface: Selenium

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

Specified by:

select in interface Selenium

Parameters:

selectLocator - an element locator identifying a drop-down menu

optionLocator - an option locator (a label by default)

addSelection

public void addSelection(java.lang.String locator,
                         java.lang.String optionLocator)

Description copied from interface: Selenium

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

Specified by:

addSelection in interface Selenium

Parameters:

locator - an element locator identifying a multi-select box

optionLocator - an option locator (a label by default)

See Also:

for details of option locators

removeSelection

public void removeSelection(java.lang.String locator,
                            java.lang.String optionLocator)

Description copied from interface: Selenium

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

Specified by:

removeSelection in interface Selenium

Parameters:

locator - an element locator identifying a multi-select box

optionLocator - an option locator (a label by default)

See Also:

for details of option locators

submit

public void submit(java.lang.String formLocator)

Description copied from interface: Selenium

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

Specified by:

submit in interface Selenium

Parameters:

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

open

public void open(java.lang.String url)

Description copied from interface: Selenium

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.

Specified by:

open in interface Selenium

Parameters:

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

openWindow

public void openWindow(java.lang.String url,
                       java.lang.String windowID)

Description copied from interface: Selenium

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

Specified by:

openWindow in interface Selenium

Parameters:

url - the URL to open, which can be blank

windowID - the JavaScript window ID of the window to select

selectWindow

public void selectWindow(java.lang.String windowID)

Description copied from interface: Selenium

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.

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

1.) if windowID is 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 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).

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:

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

Specified by:

selectWindow in interface Selenium

Parameters:

windowID - the JavaScript window ID of the window to select

selectFrame

public void selectFrame(java.lang.String locator)

Description copied from interface: Selenium

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 may also use a DOM expression to identify the frame you want directly, like this: dom=frames["main"].frames["subframe"]

Specified by:

selectFrame in interface Selenium

Parameters:

locator - an element locator identifying a frame or iframe

getLogMessages

public java.lang.String getLogMessages()

Description copied from interface: Selenium

Return the contents of the log.

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.

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.

Specified by:

getLogMessages in interface Selenium

Returns:

all log messages seen since the last call to this API

getWhetherThisFrameMatchFrameExpression

public boolean getWhetherThisFrameMatchFrameExpression(java.lang.String currentFrameString,
                                                       java.lang.String target)

Description copied from interface: Selenium

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.

Specified by:

getWhetherThisFrameMatchFrameExpression in interface Selenium

Parameters:

currentFrameString - starting frame

target - new frame (which might be relative to the current one)

Returns:

true if the new frame is this code's window

getWhetherThisWindowMatchWindowExpression

public boolean getWhetherThisWindowMatchWindowExpression(java.lang.String currentWindowString,
                                                         java.lang.String target)

Description copied from interface: Selenium

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.

Specified by:

getWhetherThisWindowMatchWindowExpression in interface Selenium

Parameters:

currentWindowString - starting window

target - new window (which might be relative to the current one, e.g., "_parent")

Returns:

true if the new window is this code's window

waitForPopUp

public void waitForPopUp(java.lang.String windowID,
                         java.lang.String timeout)

Description copied from interface: Selenium

Waits for a popup window to appear and load up.

Specified by:

waitForPopUp in interface Selenium

Parameters:

windowID - the JavaScript window ID of the window that will appear

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

chooseCancelOnNextConfirmation

public void chooseCancelOnNextConfirmation()

Description copied from interface: Selenium

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.

Specified by:

chooseCancelOnNextConfirmation in interface Selenium

answerOnNextPrompt

public void answerOnNextPrompt(java.lang.String answer)

Description copied from interface: Selenium

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

Specified by:

answerOnNextPrompt in interface Selenium

Parameters:

answer - the answer to give in response to the prompt pop-up

goBack

public void goBack()

Description copied from interface: Selenium

Simulates the user clicking the "back" button on their browser.

Specified by:

goBack in interface Selenium

refresh

public void refresh()

Description copied from interface: Selenium

Simulates the user clicking the "Refresh" button on their browser.

Specified by:

refresh in interface Selenium

close

public void close()

Description copied from interface: Selenium

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

Specified by:

close in interface Selenium

isAlertPresent

public boolean isAlertPresent()

Description copied from interface: Selenium

Has an alert occurred?

This function never throws an exception

Specified by:

isAlertPresent in interface Selenium

Returns:

true if there is an alert

isPromptPresent

public boolean isPromptPresent()

Description copied from interface: Selenium

Has a prompt occurred?

This function never throws an exception

Specified by:

isPromptPresent in interface Selenium

Returns:

true if there is a pending prompt

isConfirmationPresent

public boolean isConfirmationPresent()

Description copied from interface: Selenium

Has confirm() been called?

This function never throws an exception

Specified by:

isConfirmationPresent in interface Selenium

Returns:

true if there is a pending confirmation

getAlert

public java.lang.String getAlert()

Description copied from interface: Selenium

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

Getting an alert has the same effect as manually clicking OK. If an alert is generated but you do not get/verify it, the next Selenium action will fail.

NOTE: under Selenium, JavaScript alerts will NOT pop up a visible alert dialog.

NOTE: Selenium does NOT support JavaScript alerts that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until someone manually clicks OK.

Specified by:

getAlert in interface Selenium

Returns:

The message of the most recent JavaScript alert

getConfirmation

public java.lang.String getConfirmation()

Description copied from interface: Selenium

Retrieves the message of a JavaScript confirmation dialog generated during the previous action.

By default, the confirm function will return true, having the same effect as manually clicking OK. This can be changed by prior execution of the chooseCancelOnNextConfirmation command. If an confirmation is generated but you do not get/verify it, the next Selenium action will fail.

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

NOTE: Selenium does NOT support JavaScript confirmations that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until you manually click OK.

Specified by:

getConfirmation in interface Selenium

Returns:

the message of the most recent JavaScript confirmation dialog

getPrompt

public java.lang.String getPrompt()

Description copied from interface: Selenium

Retrieves the message of a JavaScript question prompt dialog generated during the previous action.

Successful handling of the prompt requires prior execution of the answerOnNextPrompt command. If a prompt is generated but you do not get/verify it, the next Selenium action will fail.

NOTE: under Selenium, JavaScript prompts will NOT pop up a visible dialog.

NOTE: Selenium does NOT support JavaScript prompts that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until someone manually clicks OK.

Specified by:

getPrompt in interface Selenium

Returns:

the message of the most recent JavaScript question prompt

getLocation

public java.lang.String getLocation()

Description copied from interface: Selenium

Gets the absolute URL of the current page.

Specified by:

getLocation in interface Selenium

Returns:

the absolute URL of the current page

getTitle

public java.lang.String getTitle()

Description copied from interface: Selenium

Gets the title of the current page.

Specified by:

getTitle in interface Selenium

Returns:

the title of the current page

getBodyText

public java.lang.String getBodyText()

Description copied from interface: Selenium

Gets the entire text of the page.

Specified by:

getBodyText in interface Selenium

Returns:

the entire text of the page

getValue

public java.lang.String getValue(java.lang.String locator)

Description copied from interface: Selenium

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.

Specified by:

getValue in interface Selenium

Parameters:

locator - an element locator

Returns:

the element value, or "on/off" for checkbox/radio elements

getText

public java.lang.String getText(java.lang.String locator)

Description copied from interface: Selenium

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.

Specified by:

getText in interface Selenium

Parameters:

locator - an element locator

Returns:

the text of the element

getEval

public java.lang.String getEval(java.lang.String script)

Description copied from interface: Selenium

Gets the result of evaluating the specified JavaScript snippet. The snippet may have multiple lines, but only the result of the last line will be returned.

Note that, by default, the snippet will run in the context of the "selenium" object itself, so this will refer to the Selenium object, and window will refer to the top-level runner test window, not the window of your application.

If you need a reference to the window of your application, you can refer to this.browserbot.getCurrentWindow() and if you need to use a locator to refer to a single element in your application page, you can use this.page().findElement("foo") where "foo" is your locator.

Specified by:

getEval in interface Selenium

Parameters:

script - the JavaScript snippet to run

Returns:

the results of evaluating the snippet

isChecked

public boolean isChecked(java.lang.String locator)

Description copied from interface: Selenium

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

Specified by:

isChecked in interface Selenium

Parameters:

locator - an element locator pointing to a checkbox or radio button

Returns:

true if the checkbox is checked, false otherwise

getTable

public java.lang.String getTable(java.lang.String tableCellAddress)

Description copied from interface: Selenium

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

Specified by:

getTable in interface Selenium

Parameters:

tableCellAddress - a cell address, e.g. "foo.1.4"

Returns:

the text from the specified cell

getSelectedLabels

public java.lang.String[] getSelectedLabels(java.lang.String selectLocator)

Description copied from interface: Selenium

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

Specified by:

getSelectedLabels in interface Selenium

Parameters:

selectLocator - an element locator identifying a drop-down menu

Returns:

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

getSelectedLabel

public java.lang.String getSelectedLabel(java.lang.String selectLocator)

Description copied from interface: Selenium

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

Specified by:

getSelectedLabel in interface Selenium

Parameters:

selectLocator - an element locator identifying a drop-down menu

Returns:

the selected option label in the specified select drop-down

getSelectedValues

public java.lang.String[] getSelectedValues(java.lang.String selectLocator)

Description copied from interface: Selenium

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

Specified by:

getSelectedValues in interface Selenium

Parameters:

selectLocator - an element locator identifying a drop-down menu

Returns:

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

getSelectedValue

public java.lang.String getSelectedValue(java.lang.String selectLocator)

Description copied from interface: Selenium

Gets option value (value attribute) for selected option in the specified select element.

Specified by:

getSelectedValue in interface Selenium

Parameters:

selectLocator - an element locator identifying a drop-down menu

Returns:

the selected option value in the specified select drop-down

getSelectedIndexes

public java.lang.String[] getSelectedIndexes(java.lang.String selectLocator)

Description copied from interface: Selenium

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

Specified by:

getSelectedIndexes in interface Selenium

Parameters:

selectLocator - an element locator identifying a drop-down menu

Returns:

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

getSelectedIndex

public java.lang.String getSelectedIndex(java.lang.String selectLocator)

Description copied from interface: Selenium

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

Specified by:

getSelectedIndex in interface Selenium

Parameters:

selectLocator - an element locator identifying a drop-down menu

Returns:

the selected option index in the specified select drop-down

getSelectedIds

public java.lang.String[] getSelectedIds(java.lang.String selectLocator)

Description copied from interface: Selenium

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

Specified by:

getSelectedIds in interface Selenium

Parameters:

selectLocator - an element locator identifying a drop-down menu

Returns:

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

getSelectedId

public java.lang.String getSelectedId(java.lang.String selectLocator)

Description copied from interface: Selenium

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

Specified by:

getSelectedId in interface Selenium

Parameters:

selectLocator - an element locator identifying a drop-down menu

Returns:

the selected option ID in the specified select drop-down

isSomethingSelected

public boolean isSomethingSelected(java.lang.String selectLocator)

Description copied from interface: