TypedSeleniumImpl (RichFaces-Selenium: Library 1.5.3.Final API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.test.selenium.framework
Class TypedSeleniumImpl

java.lang.Object
  org.jboss.test.selenium.framework.TypedSeleniumImpl

All Implemented Interfaces:: UnsupportedTypedSelenium, TypedSelenium

Direct Known Subclasses:: ExtendedTypedSeleniumImpl

public class TypedSeleniumImpl
extends Object
implements TypedSelenium, UnsupportedTypedSelenium
extends Object
implements TypedSelenium, UnsupportedTypedSelenium

Wrapper implementation for Selenium object's API to make it type-safe.

Version:: $Revision$
Author:: Lukas Fryc

Constructor Summary
`TypedSeleniumImpl()`

Method Summary
`void`	`addCustomRequestHeader(String key, String value)` Tells the Selenium server to add the specificed key and value as a custom outgoing request header.
`void`	`addLocationStrategy(ElementLocationStrategy locationStrategy, JavaScript strategyDefinition)` Defines a new function for Selenium to locate elements on the page.
`void`	`addScript(JavaScript javaScript)` Loads script content into a new script tag in the Selenium document.
`void`	`addSelection(ElementLocator<?> elementLocator, OptionLocator<?> optionLocator)` Add a selection to the set of selected options in a multi-select element using an option locator.
`void`	`allowNativeXpath(boolean 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.
`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(String answer)` Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()].
`IdLocator`	`assignId(ElementLocator<?> elementLocator, String 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.
`void`	`attachFile(ElementLocator<?> fieldLocator, File fileLocator)` Sets a file input (upload) field to the file listed in fileLocator
`void`	`attachFile(ElementLocator<?> fieldLocator, URL fileLocator)` Sets a file input (upload) field to the file listed in fileLocator
`BufferedImage`	`captureEntirePageScreenshot()` Downloads a screenshot of the browser current window canvas to a based 64 encoded PNG file.
`void`	`captureEntirePageScreenshot(File filename)` Saves the entire contents of the current window canvas to a PNG file.
`NetworkTraffic`	`captureNetworkTraffic(NetworkTrafficType type)` Returns the network traffic seen by the browser, including headers, AJAX requests, status codes, and timings.
`BufferedImage`	`captureScreenshot()` Capture a PNG screenshot.
`void`	`captureScreenshot(File filename)` Captures a PNG screenshot to the specified file.
`void`	`check(ElementLocator<?> elementLocator)` 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; after running this command, the next call to confirm() will return false, as if the user had clicked Cancel.
`void`	`chooseOkOnNextConfirmation()` Undo the effect of calling chooseCancelOnNextConfirmation.
`void`	`click(ElementLocator<?> elementLocator)` Clicks on a link, button, checkbox or radio button.
`void`	`clickAt(ElementLocator<?> elementLocator, Point point)` 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.
`boolean`	`containsScript(JavaScript javaScript)` Checks whenever the script is already added.
`void`	`contextMenu(ElementLocator<?> elementLocator)` Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
`void`	`contextMenuAt(ElementLocator<?> elementLocator, Point point)` Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
`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(Cookie cookie)` Create a new cookie whose path and domain are same with those of current page under test.
`void`	`createCookie(Cookie cookie, CreateCookieOptions options)` 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 in options.
`void`	`deleteAllVisibleCookies()` Calls deleteCookie with recurse=true on all cookies visible to the current page.
`void`	`deleteCookie(String cookieName, DeleteCookieOptions options)` Delete a named cookie with specified options.
`void`	`deselectPopUp()` Selects the main window.
`void`	`doubleClick(ElementLocator<?> elementLocator)` Double clicks on a link, button, checkbox or radio button.
`void`	`doubleClickAt(ElementLocator<?> elementLocator, Point point)` Doubleclicks on a link, button, checkbox or radio button.
`void`	`dragAndDrop(ElementLocator<?> elementLocator, Offset offset)` Drags an element a certain distance and then drops it
`void`	`dragAndDropToObject(ElementLocator<?> elementLocatorOfObjectToBeDragged, ElementLocator<?> elementLocatorOfDragDestinationObject)` Drags an element and drops it on another element
`void`	`dragdrop(ElementLocator<?> elementLocator, Offset offset)` deprecated - use dragAndDrop instead
`void`	`fireEvent(ElementLocator<?> elementLocator, Event event)` Explicitly simulate an event, to trigger the corresponding handler.
`void`	`focus(ElementLocator<?> elementLocator)` Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field.
`String`	`getAlert()` Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts.
`List<ElementLocator<?>>`	`getAllButtons()` Returns the IDs of all buttons on the page.
`Set<Cookie>`	`getAllCookies()` Return all cookies of the current page under test.
`List<ElementLocator<?>>`	`getAllFields()` Returns the IDs of all input fields on the page.
`List<ElementLocator<?>>`	`getAllLinks()` Returns the IDs of all links on the page.
`List<WindowId>`	`getAllWindowIds()` Returns the IDs of all windows that the browser knows about.
`List<String>`	`getAllWindowNames()` Returns the names of all windows that the browser knows about.
`List<String>`	`getAllWindowTitles()` Returns the titles of all windows that the browser knows about.
`String`	`getAttribute(AttributeLocator<?> attributeLocator)` Gets the value of an element attribute.
`List<String>`	`getAttributeFromAllWindows(Attribute attribute)` Returns every instance of some attribute from all known windows.
`String`	`getBodyText()` Gets the entire text of the page.
`String`	`getConfirmation()` Retrieves the message of a JavaScript confirmation dialog generated during the previous action.
`Cookie`	`getCookieByName(String cookieName)` Returns the value of the cookie with the specified name, or throws an error if the cookie is not present.
`int`	`getCount(IterableLocator<?> locator)` Returns the number of elements that match the specified locator.
`int`	`getCursorPosition(ElementLocator<?> elementLocator)` Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers.
`Dimension`	`getElementDimension(ElementLocator<?> elementLocator)` Retrievers the element dimensions (width, height)
`int`	`getElementHeight(ElementLocator<?> elementLocator)` Retrieves the height of an element
`int`	`getElementIndex(ElementLocator<?> elementLocator)` Get the relative index of an element to its parent (starting from 0).
`Point`	`getElementPosition(ElementLocator<?> elementLocator)` Retrieves the position of an element
`int`	`getElementPositionLeft(ElementLocator<?> elementLocator)` Retrieves the horizontal position of an element
`int`	`getElementPositionTop(ElementLocator<?> elementLocator)` Retrieves the vertical position of an element
`int`	`getElementWidth(ElementLocator<?> elementLocator)` Retrieves the width of an element
`String`	`getEval(JavaScript script)` Gets the result of evaluating the specified JavaScript snippet.
`JavaScript`	`getExpression(JavaScript expression)` Returns the specified expression.
`String`	`getHtmlSource()` Returns the entire HTML source between the opening and closing "html" tags.
`URL`	`getLocation()` Gets the absolute URL of the current page.
`int`	`getMouseSpeed()` Returns the number of pixels between "mousemove" events during dragAndDrop commands (default=10).
`String`	`getPrompt()` Retrieves the message of a JavaScript question prompt dialog generated during the previous action.
`String`	`getSelectedId(ElementLocator<?> selectLocator)` Gets option element ID for selected option in the specified select element.
`List<String>`	`getSelectedIds(ElementLocator<?> selectLocator)` Gets all option element IDs for selected options in the specified select or multi-select element.
`int`	`getSelectedIndex(ElementLocator<?> selectLocator)` Gets option index (option number, starting at 0) for selected option in the specified select element.
`List<Integer>`	`getSelectedIndexes(ElementLocator<?> selectLocator)` Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.
`String`	`getSelectedLabel(ElementLocator<?> selectLocator)` Gets option label (visible text) for selected option in the specified select element.
`List<String>`	`getSelectedLabels(ElementLocator<?> selectLocator)` Gets all option labels (visible text) for selected options in the specified select or multi-select element.
`String`	`getSelectedValue(ElementLocator<?> selectLocator)` Gets option value (value attribute) for selected option in the specified select element.
`List<String>`	`getSelectedValues(ElementLocator<?> selectLocator)` Gets all option values (value attributes) for selected options in the specified select or multi-select element.
`List<String>`	`getSelectOptions(ElementLocator<?> selectLocator)` Gets all option labels in the specified select drop-down.
`long`	`getSpeed()` Get execution speed (i.e., get the millisecond length of the delay following each selenium operation).
`String`	`getText(ElementLocator<?> elementLocator)` Gets the text of an element.
`String`	`getTitle()` Gets the title of the current page.
`String`	`getValue(ElementLocator<?> elementLocator)` Gets the (whitespace-trimmed) value of an input field (or anything else with a value parameter).
`boolean`	`getWhetherThisFrameMatchFrameExpression(Frame currentFrame, Frame targetFrame)` Determine whether current/locator identify the frame containing this running code.
`boolean`	`getWhetherThisWindowMatchWindowExpression(Window currentWindowString, Window 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.
`void`	`highlight(ElementLocator<?> elementLocator)` Briefly changes the backgroundColor of the specified element yellow.
`void`	`ignoreAttributesWithoutValue(boolean ignore)` Specifies whether Selenium will ignore xpath attributes that have no value, i.e.
`boolean`	`isAlertPresent()` Has an alert occurred?
`boolean`	`isChecked(ElementLocator<?> elementLocator)` Gets whether a toggle-button (checkbox/radio) is checked.
`boolean`	`isConfirmationPresent()` Has confirm() been called?
`boolean`	`isCookiePresent(String cookieName)` Returns true if a cookie with the specified name is present, or false otherwise.
`boolean`	`isEditable(ElementLocator<?> elementLocator)` Determines whether the specified input element is editable, ie hasn't been disabled.
`boolean`	`isElementPresent(ElementLocator<?> elementLocator)` Verifies that the specified element is somewhere on the page.
`boolean`	`isOrdered(ElementLocator<?> elementLocator1, ElementLocator<?> elementLocator2)` Check if these two elements have same parent and are ordered siblings in the DOM.
`boolean`	`isPromptPresent()` Has a prompt occurred?
`boolean`	`isSomethingSelected(ElementLocator<?> selectLocator)` Determines whether some option in a drop-down menu is selected.
`boolean`	`isTextPresent(String text)` Verifies that the specified text pattern appears somewhere on the rendered page shown to the user.
`boolean`	`isVisible(ElementLocator<?> elementLocator)` Determines if the specified element is visible.
`void`	`keyDown(ElementLocator<?> elementLocator, String keySequence)` Simulates a user pressing a key (without releasing it yet).
`void`	`keyDownNative(String keycode)` Simulates a user pressing a key (without releasing it yet) by sending a native operating system keystroke.
`void`	`keyPress(ElementLocator<?> elementLocator, String keySequence)` Simulates a user pressing and releasing a key.
`void`	`keyPressNative(String keycode)` Simulates a user pressing and releasing a key by sending a native operating system keystroke.
`void`	`keyUp(ElementLocator<?> elementLocator, String keySequence)` Simulates a user releasing a key.
`void`	`keyUpNative(String keycode)` Simulates a user releasing a key by sending a native operating system keystroke.
`void`	`logToBrowser(String textToLog)` Writes a message to the status bar and adds a note to the browser-side log.
`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(ElementLocator<?> elementLocator)` Simulates a user pressing the left mouse button (without releasing it yet) on the specified element.
`void`	`mouseDownAt(ElementLocator<?> elementLocator, Point point)` Simulates a user pressing the left mouse button (without releasing it yet) at the specified location.
`void`	`mouseDownRight(ElementLocator<?> elementLocator)` Simulates a user pressing the right mouse button (without releasing it yet) on the specified element.
`void`	`mouseDownRightAt(ElementLocator<?> elementLocator, Point point)` Simulates a user pressing the right mouse button (without releasing it yet) at the specified location.
`void`	`mouseMove(ElementLocator<?> elementLocator)` Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
`void`	`mouseMoveAt(ElementLocator<?> elementLocator, Point point)` Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
`void`	`mouseOut(ElementLocator<?> elementLocator)` Simulates a user moving the mouse pointer away from the specified element.
`void`	`mouseOver(ElementLocator<?> elementLocator)` Simulates a user hovering a mouse over the specified element.
`void`	`mouseUp(ElementLocator<?> elementLocator)` Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) on the specified element.
`void`	`mouseUpAt(ElementLocator<?> elementLocator, Point point)` Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) at the specified location.
`void`	`mouseUpRight(ElementLocator<?> elementLocator)` Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) on the specified element.
`void`	`mouseUpRightAt(ElementLocator<?> elementLocator, Point point)` Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) at the specified location.
`void`	`open(URL url)` Opens an URL in the test frame.
`void`	`openWindow(URL url, WindowId 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`	`removeAllSelections(ElementLocator<?> elementLocator)` Unselects all of the selected options in a multi-select element.
`void`	`removeScript(JavaScript javaScript)` Removes a script tag from the Selenium document identified by the JavaScript's id (see `JavaScript.getIdentification()`.
`void`	`removeSelection(ElementLocator<?> elementLocator, OptionLocator<?> optionLocator)` Remove a selection from the set of selected options in a multi-select element using an option locator.
`String`	`retrieveLastRemoteControlLogs()` Retrieve the last messages logged on a specific remote control.
`void`	`runScript(JavaScript script)` Creates a new "script" tag in the body of the current test window, and adds the specified text into the body of the command.
`void`	`select(ElementLocator<?> selectLocator, OptionLocator<?> optionLocator)` Select an option from a drop-down using an option locator.
`void`	`selectFrame(FrameLocator frameLocator)` Selects a frame within the current window.
`void`	`selectPopUp(WindowId windowID)` Simplifies the process of selecting a popup window (and does not offer functionality beyond what `selectWindow()` already provides).
`void`	`selectWindow(WindowId windowID)` Selects a popup window using a window locator; once a popup window has been selected, all commands go to that window.
`void`	`setBrowserLogLevel(LogLevel logLevel)` Sets the threshold for browser-side logging messages; log messages beneath this threshold will be discarded.
`void`	`setCursorPosition(ElementLocator<?> elementLocator, int position)` Moves the text cursor to the specified position in the given input element or textarea.
`void`	`setExtensionJs(JavaScript extensionJs)` Sets the per-session extension Javascript
`void`	`setMouseSpeed(int pixels)` Configure the number of pixels between "mousemove" events during dragAndDrop commands (default=10).
`void`	`setSpeed(long speedInMilis)` Set execution speed (i.e., set the millisecond length of a delay which will follow each selenium operation).
`void`	`setTimeout(long timeoutInMilis)` 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`	`shutDownSeleniumServer()` Kills the running Selenium Server and all browser sessions.
`void`	`start()` Launches the browser with a new Selenium session
`void`	`stop()` Ends the test session, killing the browser
`void`	`submit(ElementLocator<?> formLocator)` Submit the specified form.
`void`	`type(ElementLocator<?> elementLocator, String value)` Sets the value of an input field, as though you typed it in.
`void`	`typeKeys(ElementLocator<?> elementLocator, String value)` Simulates keystroke events on the specified element, as though you typed the value key-by-key.
`void`	`uncheck(ElementLocator<?> elementLocator)` Uncheck a toggle-button (checkbox/radio)
`void`	`useXpathLibrary(XpathLibrary xpathLibrary)` Allows choice of one of the available libraries.
`void`	`waitForCondition(JavaScript script)` Runs the specified JavaScript snippet repeatedly until it evaluates to "true".
`void`	`waitForCondition(JavaScript script, long timeout)` Runs the specified JavaScript snippet repeatedly until it evaluates to "true".
`void`	`waitForFrameToLoad(URL frameURL)` Waits for a new frame to load.
`void`	`waitForFrameToLoad(URL frameURL, long timeout)` Waits for a new frame to load.
`void`	`waitForPageToLoad()` Waits for a new page to load.
`void`	`waitForPageToLoad(long timeout)` Waits for a new page to load.
`void`	`waitForPopUp(WindowId windowId, long timeoutInMilis)` Waits for a popup window to appear and load up.
`void`	`windowFocus()` Gives focus to the currently selected window
`void`	`windowMaximize()` Resize currently selected 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`

Constructor Detail

TypedSeleniumImpl

public TypedSeleniumImpl()

Method Detail

addCustomRequestHeader

public void addCustomRequestHeader(String key,
                                   String value)

Description copied from interface: UnsupportedTypedSelenium

Tells the Selenium server to add the specificed key and value as a custom outgoing request header. This only works if the browser is configured to use the built in Selenium proxy.

Specified by:: addCustomRequestHeader in interface UnsupportedTypedSelenium

Parameters:: key - the header name.; value - the header value.

addLocationStrategy

public void addLocationStrategy(ElementLocationStrategy locationStrategy,
                                JavaScript strategyDefinition)

Description copied from interface: TypedSelenium

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.

Specified by:: addLocationStrategy in interface TypedSelenium

Parameters:: locationStrategy - the name of the strategy to define; this should use only letters [a-zA-Z] with no spaces or other punctuation.; strategyDefinition - a string defining the body of a function in JavaScript. For example: return inDocument.getElementById(locator);

addScript

public void addScript(JavaScript javaScript)

Description copied from interface: TypedSelenium

Loads script content into a new script tag in the Selenium document. This differs from the runScript command in that runScript adds the script tag to the document of the AUT, not the Selenium document. The following entities in the script content are replaced by the characters they represent: < > & The corresponding remove command is removeScript.

Specified by:: addScript in interface TypedSelenium

Parameters:: javaScript - the JavaScript script to add

addSelection

public void addSelection(ElementLocator<?> elementLocator,
                         OptionLocator<?> optionLocator)

Description copied from interface: TypedSelenium

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

Specified by:: addSelection in interface TypedSelenium

Parameters:: elementLocator - an element locator identifying a multi-select box; optionLocator - an option locator (a label by default)
See Also:: for details of option locators

allowNativeXpath

public void allowNativeXpath(boolean allow)

Description copied from interface: TypedSelenium

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.

Specified by:: allowNativeXpath in interface TypedSelenium

Parameters:: allow - boolean, true means we'll prefer to use native XPath; false means we'll only use JS XPath

altKeyDown

public void altKeyDown()

Description copied from interface: TypedSelenium

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

Specified by:: altKeyDown in interface TypedSelenium

altKeyUp

public void altKeyUp()

Description copied from interface: TypedSelenium

Release the alt key.

Specified by:: altKeyUp in interface TypedSelenium

answerOnNextPrompt

public void answerOnNextPrompt(String answer)

Description copied from interface: TypedSelenium

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

Specified by:: answerOnNextPrompt in interface TypedSelenium

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

assignId

public IdLocator assignId(ElementLocator<?> elementLocator,
                          String identifier)

Description copied from interface: TypedSelenium

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.

Specified by:: assignId in interface TypedSelenium

Parameters:: elementLocator - an element locator pointing to an element; identifier - a string to be used as the ID of the specified element

attachFile

public void attachFile(ElementLocator<?> fieldLocator,
                       File fileLocator)

Description copied from interface: UnsupportedTypedSelenium

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

Specified by:: attachFile in interface UnsupportedTypedSelenium

Parameters:: fieldLocator - an element locator; fileLocator - a URL pointing to the specified file. Before the file can be set in the input field (fieldLocator), Selenium RC may need to transfer the file to the local machine before attaching the file in a web page form. This is common in selenium grid configurations where the RC server driving the browser is not the same machine that started the test. Supported Browsers: Firefox ("*chrome") only.

attachFile

public void attachFile(ElementLocator<?> fieldLocator,
                       URL fileLocator)

Description copied from interface: UnsupportedTypedSelenium

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

Specified by:: attachFile in interface UnsupportedTypedSelenium

Parameters:: fieldLocator - an element locator; fileLocator - a URL pointing to the specified file. Before the file can be set in the input field (fieldLocator), Selenium RC may need to transfer the file to the local machine before attaching the file in a web page form. This is common in selenium grid configurations where the RC server driving the browser is not the same machine that started the test. Supported Browsers: Firefox ("*chrome") only.

captureEntirePageScreenshot

public void captureEntirePageScreenshot(File filename)

Description copied from interface: UnsupportedTypedSelenium

Saves the entire contents of the current window canvas to a PNG file. Contrast this with the captureScreenshot command, which captures the contents of the OS viewport (i.e. whatever is currently being displayed on the monitor), and is implemented in the RC only. Currently this only works in Firefox when running in chrome mode, and in IE non-HTA using the EXPERIMENTAL "Snapsie" utility. The Firefox implementation is mostly borrowed from the Screengrab! Firefox extension. Please see http://www.screengrab.org and http://snapsie.sourceforge.net/ for details.

Specified by:: captureEntirePageScreenshot in interface UnsupportedTypedSelenium

Parameters:: filename - the path to the file to persist the screenshot as. No filename extension will be appended by default. Directories will not be created if they do not exist, and an exception will be thrown, possibly by native code.

captureEntirePageScreenshot

public BufferedImage captureEntirePageScreenshot()

Description copied from interface: TypedSelenium

Downloads a screenshot of the browser current window canvas to a based 64 encoded PNG file. The entire windows canvas is captured, including parts rendered outside of the current view port. Currently this only works in Mozilla and when running in chrome mode.

Specified by:: captureEntirePageScreenshot in interface TypedSelenium

Returns:: The BufferedImage

captureNetworkTraffic

public NetworkTraffic captureNetworkTraffic(NetworkTrafficType type)

Description copied from interface: TypedSelenium

Returns the network traffic seen by the browser, including headers, AJAX requests, status codes, and timings. When this function is called, the traffic log is cleared, so the returned content is only the traffic seen since the last call.

Specified by:: captureNetworkTraffic in interface TypedSelenium

Parameters:: type - The type of data to return the network traffic as. Valid values are: json, xml, or plain.
Returns:: A string representation in the defined type of the network traffic seen by the browser.

captureScreenshot

public void captureScreenshot(File filename)

Description copied from interface: UnsupportedTypedSelenium

Captures a PNG screenshot to the specified file.

Specified by:: captureScreenshot in interface UnsupportedTypedSelenium

Parameters:: filename - the absolute path to the file to be written, e.g. "c:\blah\screenshot.png"

captureScreenshot

public BufferedImage captureScreenshot()

Description copied from interface: TypedSelenium

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

Specified by:: captureScreenshot in interface TypedSelenium

Returns:: The BufferedImage

check

public void check(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

Check a toggle-button (checkbox/radio)

Specified by:: check in interface TypedSelenium

Parameters:: elementLocator - an element locator

chooseCancelOnNextConfirmation

public void chooseCancelOnNextConfirmation()

Description copied from interface: TypedSelenium

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.

Specified by:: chooseCancelOnNextConfirmation in interface TypedSelenium

chooseOkOnNextConfirmation

public void chooseOkOnNextConfirmation()

Description copied from interface: TypedSelenium

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.

Specified by:: chooseOkOnNextConfirmation in interface TypedSelenium

click

public void click(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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 TypedSelenium

Parameters:: elementLocator - an element locator

clickAt

public void clickAt(ElementLocator<?> elementLocator,
                    Point point)

Description copied from interface: TypedSelenium

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 TypedSelenium

Parameters:: elementLocator - an element locator; point - specifies the point (x,y position) of the mouse event relative to the element returned by the locator.

close

public void close()

Description copied from interface: TypedSelenium

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

Specified by:: close in interface TypedSelenium

containsScript

public boolean containsScript(JavaScript javaScript)

Description copied from interface: TypedSelenium

Checks whenever the script is already added. Check is based on JavaScript's id (see JavaScript.getIdentification().

Specified by:: containsScript in interface TypedSelenium

Parameters:: javaScript - JavaScript we want to check if it is added
Returns:: true if the javaScript is already added; false otherwise

contextMenu

public void contextMenu(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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

Specified by:: contextMenu in interface TypedSelenium

Parameters:: elementLocator - an element locator

contextMenuAt

public void contextMenuAt(ElementLocator<?> elementLocator,
                          Point point)

Description copied from interface: TypedSelenium

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

Specified by:: contextMenuAt in interface TypedSelenium

Parameters:: elementLocator - an element locator

controlKeyDown

public void controlKeyDown()

Description copied from interface: TypedSelenium

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

Specified by:: controlKeyDown in interface TypedSelenium

controlKeyUp

public void controlKeyUp()

Description copied from interface: TypedSelenium

Release the control key.

Specified by:: controlKeyUp in interface TypedSelenium

deleteAllVisibleCookies

public void deleteAllVisibleCookies()

Description copied from interface: TypedSelenium

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.

Specified by:: deleteAllVisibleCookies in interface TypedSelenium

deselectPopUp

public void deselectPopUp()

Description copied from interface: TypedSelenium

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

Specified by:: deselectPopUp in interface TypedSelenium

doubleClick

public void doubleClick(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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 TypedSelenium

Parameters:: elementLocator - an element locator

doubleClickAt

public void doubleClickAt(ElementLocator<?> elementLocator,
                          Point point)

Description copied from interface: TypedSelenium

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 TypedSelenium

Parameters:: elementLocator - an element locator

dragAndDrop

public void dragAndDrop(ElementLocator<?> elementLocator,
                        Offset offset)

Description copied from interface: TypedSelenium

Drags an element a certain distance and then drops it

Specified by:: dragAndDrop in interface TypedSelenium

Parameters:: elementLocator - an element locator; offset - offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"

dragAndDropToObject

public void dragAndDropToObject(ElementLocator<?> elementLocatorOfObjectToBeDragged,
                                ElementLocator<?> elementLocatorOfDragDestinationObject)

Description copied from interface: TypedSelenium

Drags an element and drops it on another element

Specified by:: dragAndDropToObject in interface TypedSelenium

Parameters:: elementLocatorOfObjectToBeDragged - an element to be dragged; elementLocatorOfDragDestinationObject - an element whose location (i.e., whose center-most pixel) will be the point where locatorOfObjectToBeDragged is dropped

dragdrop

public void dragdrop(ElementLocator<?> elementLocator,
                     Offset offset)

Description copied from interface: TypedSelenium

deprecated - use dragAndDrop instead

Specified by:: dragdrop in interface TypedSelenium

Parameters:: elementLocator - an element locator; offset - offset in pixels from the current location to which the element should be moved

fireEvent

public void fireEvent(ElementLocator<?> elementLocator,
                      Event event)

Description copied from interface: TypedSelenium

Explicitly simulate an event, to trigger the corresponding handler.

Specified by:: fireEvent in interface TypedSelenium

Parameters:: elementLocator - an element locator

focus

public void focus(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field.

Specified by:: focus in interface TypedSelenium

Parameters:: elementLocator - an element locator

getAlert

public String getAlert()

Description copied from interface: TypedSelenium

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.

Specified by:: getAlert in interface TypedSelenium

Returns:: The message of the most recent JavaScript alert

getAllButtons

public List<ElementLocator<?>> getAllButtons()

Description copied from interface: UnsupportedTypedSelenium

Returns the IDs of all buttons on the page.

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

Specified by:: getAllButtons in interface UnsupportedTypedSelenium

Returns:: the IDs of all buttons on the page

getAllFields

public List<ElementLocator<?>> getAllFields()

Description copied from interface: UnsupportedTypedSelenium

Returns the IDs of all input fields on the page.

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

Specified by:: getAllFields in interface UnsupportedTypedSelenium

Returns:: the IDs of all field on the page

getAllLinks

public List<ElementLocator<?>> getAllLinks()

Description copied from interface: UnsupportedTypedSelenium

Returns the IDs of all links on the page.

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

Specified by:: getAllLinks in interface UnsupportedTypedSelenium

Returns:: the IDs of all links on the page

getAllWindowIds

public List<WindowId> getAllWindowIds()

Description copied from interface: UnsupportedTypedSelenium

Returns the IDs of all windows that the browser knows about.

Specified by:: getAllWindowIds in interface UnsupportedTypedSelenium

Returns:: the IDs of all windows that the browser knows about.

getAllWindowNames

public List<String> getAllWindowNames()

Description copied from interface: UnsupportedTypedSelenium

Returns the names of all windows that the browser knows about.

Specified by:: getAllWindowNames in interface UnsupportedTypedSelenium

Returns:: the names of all windows that the browser knows about.

getAllWindowTitles

public List<String> getAllWindowTitles()

Description copied from interface: UnsupportedTypedSelenium

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

Specified by:: getAllWindowTitles in interface UnsupportedTypedSelenium

Returns:: the titles of all windows that the browser knows about.

getAttribute

public String getAttribute(AttributeLocator<?> attributeLocator)

Description copied from interface: TypedSelenium

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

Specified by:: getAttribute in interface TypedSelenium

Parameters:: attributeLocator - attribute locator
Returns:: the value of the specified attribute

getAttributeFromAllWindows

public List<String> getAttributeFromAllWindows(Attribute attribute)

Description copied from interface: UnsupportedTypedSelenium

Returns every instance of some attribute from all known windows.

Specified by:: getAttributeFromAllWindows in interface UnsupportedTypedSelenium

Returns:: the set of values of this attribute from all known windows.

getBodyText

public String getBodyText()

Description copied from interface: TypedSelenium

Gets the entire text of the page.

Specified by:: getBodyText in interface TypedSelenium

Returns:: the entire text of the page

getConfirmation

public String getConfirmation()

Description copied from interface: TypedSelenium

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.

Specified by:: getConfirmation in interface TypedSelenium

Returns:: the message of the most recent JavaScript confirmation dialog

getCount

public int getCount(IterableLocator<?> locator)

Description copied from interface: TypedSelenium

Returns the number of elements that match the specified locator.

Specified by:: getCount in interface TypedSelenium

Returns:: the number of nodes that match the specified locator

getCursorPosition

public int getCursorPosition(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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.

Specified by:: getCursorPosition in interface TypedSelenium

Parameters:: elementLocator - an element locator pointing to an input element or textarea
Returns:: the numerical position of the cursor in the field

getElementDimension

public Dimension getElementDimension(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

Retrievers the element dimensions (width, height)

Specified by:: getElementDimension in interface TypedSelenium

Parameters:: elementLocator - an element locator pointing to an element
Returns:: dimensions of an element in pixels

getElementHeight

public int getElementHeight(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

Retrieves the height of an element

Specified by:: getElementHeight in interface TypedSelenium

Parameters:: elementLocator - an element locator pointing to an element
Returns:: height of an element in pixels

getElementIndex

public int getElementIndex(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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

Specified by:: getElementIndex in interface TypedSelenium

Parameters:: elementLocator - an element locator pointing to an element
Returns:: of relative index of the element to its parent (starting from 0)

getElementPosition

public Point getElementPosition(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

Retrieves the position of an element

Specified by:: getElementPosition in interface TypedSelenium

Returns:: the position in the current frame

getElementPositionLeft

public int getElementPositionLeft(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

Retrieves the horizontal position of an element

Specified by:: getElementPositionLeft in interface TypedSelenium

Parameters:: elementLocator - an element locator pointing to an element
Returns:: of pixels from the edge of the frame.

getElementPositionTop

public int getElementPositionTop(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

Retrieves the vertical position of an element

Specified by:: getElementPositionTop in interface TypedSelenium

Parameters:: elementLocator - an element locator pointing to an element
Returns:: of pixels from the edge of the frame.

getElementWidth

public int getElementWidth(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

Retrieves the width of an element

Specified by:: getElementWidth in interface TypedSelenium

Parameters:: elementLocator - an element locator pointing to an element
Returns:: width of an element in pixels

getEval

public String getEval(JavaScript script)

Description copied from interface: TypedSelenium

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.

Specified by:: getEval in interface TypedSelenium

Parameters:: script - the JavaScript snippet to run
Returns:: the results of evaluating the snippet

getExpression

public JavaScript getExpression(JavaScript expression)

Description copied from interface: UnsupportedTypedSelenium

Returns the specified expression.

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

Specified by:: getExpression in interface UnsupportedTypedSelenium

Parameters:: expression - the value to return
Returns:: the value passed in

getHtmlSource

public String getHtmlSource()

Description copied from interface: TypedSelenium

Returns the entire HTML source between the opening and closing "html" tags.

Specified by:: getHtmlSource in interface TypedSelenium

Returns:: the entire HTML source

getLocation

public URL getLocation()

Description copied from interface: TypedSelenium

Gets the absolute URL of the current page.

Specified by:: getLocation in interface TypedSelenium

Returns:: the absolute URL of the current page

getMouseSpeed

public int getMouseSpeed()

Description copied from interface: TypedSelenium

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

Specified by:: getMouseSpeed in interface TypedSelenium

Returns:: the number of pixels between "mousemove" events during dragAndDrop commands (default=10)

getPrompt

public String getPrompt()

Description copied from interface: TypedSelenium

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 TypedSelenium

Returns:: the message of the most recent JavaScript question prompt

getSelectOptions

public List<String> getSelectOptions(ElementLocator<?> selectLocator)

Description copied from interface: TypedSelenium

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

Specified by:: getSelectOptions in interface TypedSelenium

Parameters:: selectLocator - an element locator identifying a drop-down menu
Returns:: an array of all option labels in the specified select drop-down

getSelectedId

public String getSelectedId(ElementLocator<?> selectLocator)

Description copied from interface: TypedSelenium

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

Specified by:: getSelectedId in interface TypedSelenium

Parameters:: selectLocator - an element locator identifying a drop-down menu
Returns:: the selected option ID in the specified select drop-down

getSelectedIds

public List<String> getSelectedIds(ElementLocator<?> selectLocator)

Description copied from interface: TypedSelenium

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

Specified by:: getSelectedIds in interface TypedSelenium

Parameters:: selectLocator - an element locator identifying a drop-down menu
Returns:: an array of all selected option IDs in the specified select drop-down

getSelectedIndex

public int getSelectedIndex(ElementLocator<?> selectLocator)

Description copied from interface: TypedSelenium

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

Specified by:: getSelectedIndex in interface TypedSelenium

Parameters:: selectLocator - an element locator identifying a drop-down menu
Returns:: the selected option index in the specified select drop-down

getSelectedIndexes

public List<Integer> getSelectedIndexes(ElementLocator<?> selectLocator)

Description copied from interface: TypedSelenium

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 TypedSelenium

Parameters:: selectLocator - an element locator identifying a drop-down menu
Returns:: an array of all selected option indexes in the specified select drop-down

getSelectedLabel

public String getSelectedLabel(ElementLocator<?> selectLocator)

Description copied from interface: TypedSelenium

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

Specified by:: getSelectedLabel in interface TypedSelenium

Parameters:: selectLocator - an element locator identifying a drop-down menu
Returns:: the selected option label in the specified select drop-down

getSelectedLabels

public List<String> getSelectedLabels(ElementLocator<?> selectLocator)

Description copied from interface: TypedSelenium

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

Specified by:: getSelectedLabels in interface TypedSelenium

Parameters:: selectLocator - an element locator identifying a drop-down menu
Returns:: an array of all selected option labels in the specified select drop-down

getSelectedValue

public String getSelectedValue(ElementLocator<?> selectLocator)

Description copied from interface: TypedSelenium

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

Specified by:: getSelectedValue in interface TypedSelenium

Parameters:: selectLocator - an element locator identifying a drop-down menu
Returns:: the selected option value in the specified select drop-down

getSelectedValues

public List<String> getSelectedValues(ElementLocator<?> selectLocator)

Description copied from interface: TypedSelenium

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

Specified by:: getSelectedValues in interface TypedSelenium

Parameters:: selectLocator - an element locator identifying a drop-down menu
Returns:: an array of all selected option values in the specified select drop-down

getSpeed

public long getSpeed()

Description copied from interface: TypedSelenium

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 TypedSelenium

Returns:: the execution speed in milliseconds.

getText

public String getText(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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 TypedSelenium

Parameters:: elementLocator - an element locator
Returns:: the text of the element

getTitle

public String getTitle()

Description copied from interface: TypedSelenium

Gets the title of the current page.

Specified by:: getTitle in interface TypedSelenium

Returns:: the title of the current page

getValue

public String getValue(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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 TypedSelenium

Parameters:: elementLocator - an element locator
Returns:: the element value, or "on/off" for checkbox/radio elements

getWhetherThisFrameMatchFrameExpression

public boolean getWhetherThisFrameMatchFrameExpression(Frame currentFrame,
                                                       Frame targetFrame)

Description copied from interface: UnsupportedTypedSelenium

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 UnsupportedTypedSelenium

Returns:: true if the new frame is this code's window

getWhetherThisWindowMatchWindowExpression

public boolean getWhetherThisWindowMatchWindowExpression(Window currentWindowString,
                                                         Window target)

Description copied from interface: UnsupportedTypedSelenium

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 UnsupportedTypedSelenium

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

goBack

public void goBack()

Description copied from interface: TypedSelenium

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

Specified by:: goBack in interface TypedSelenium

highlight

public void highlight(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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

Specified by:: highlight in interface TypedSelenium

Parameters:: elementLocator - an element locator

ignoreAttributesWithoutValue

public void ignoreAttributesWithoutValue(boolean ignore)

Description copied from interface: TypedSelenium

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

Specified by:: ignoreAttributesWithoutValue in interface TypedSelenium

Parameters:: ignore - boolean, true means we'll ignore attributes without value at the expense of xpath "correctness"; false means we'll sacrifice speed for correctness.

isAlertPresent

public boolean isAlertPresent()

Description copied from interface: TypedSelenium

Has an alert occurred?

This function never throws an exception

Specified by:: isAlertPresent in interface TypedSelenium

Returns:: true if there is an alert

isChecked

public boolean isChecked(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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 TypedSelenium

Parameters:: elementLocator - an element locator pointing to a checkbox or radio button
Returns:: true if the checkbox is checked, false otherwise

isConfirmationPresent

public boolean isConfirmationPresent()

Description copied from interface: TypedSelenium

Has confirm() been called?

This function never throws an exception

Specified by:: isConfirmationPresent in interface TypedSelenium

Returns:: true if there is a pending confirmation

isEditable

public boolean isEditable(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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.

Specified by:: isEditable in interface TypedSelenium

Parameters:: elementLocator - an element locator
Returns:: true if the input element is editable, false otherwise

isElementPresent

public boolean isElementPresent(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

Verifies that the specified element is somewhere on the page.

Specified by:: isElementPresent in interface TypedSelenium

Parameters:: elementLocator - an element locator
Returns:: true if the element is present, false otherwise

isOrdered

public boolean isOrdered(ElementLocator<?> elementLocator1,
                         ElementLocator<?> elementLocator2)

Description copied from interface: TypedSelenium

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

Specified by:: isOrdered in interface TypedSelenium

Parameters:: elementLocator1 - an element locator pointing to the first element; elementLocator2 - an element locator pointing to the second element
Returns:: true if element1 is the previous sibling of element2, false otherwise

isPromptPresent

public boolean isPromptPresent()

Description copied from interface: TypedSelenium

Has a prompt occurred?

This function never throws an exception

Specified by:: isPromptPresent in interface TypedSelenium

Returns:: true if there is a pending prompt

isSomethingSelected

public boolean isSomethingSelected(ElementLocator<?> selectLocator)

Description copied from interface: TypedSelenium

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

Specified by:: isSomethingSelected in interface TypedSelenium

Parameters:: selectLocator - an element locator identifying a drop-down menu
Returns:: true if some option has been selected, false otherwise

isTextPresent

public boolean isTextPresent(String text)

Description copied from interface: TypedSelenium

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

Specified by:: isTextPresent in interface TypedSelenium

Parameters:: text - a pattern to match with the text of the page
Returns:: true if the pattern matches the text, false otherwise

isVisible

public boolean isVisible(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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.

Specified by:: isVisible in interface TypedSelenium

Parameters:: elementLocator - an element locator
Returns:: true if the specified element is visible, false otherwise

keyDown

public void keyDown(ElementLocator<?> elementLocator,
                    String keySequence)

Description copied from interface: TypedSelenium

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

Specified by:: keyDown in interface TypedSelenium

Parameters:: elementLocator - 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".

keyDownNative

public void keyDownNative(String keycode)

Description copied from interface: TypedSelenium

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.

Specified by:: keyDownNative in interface TypedSelenium

Parameters:: keycode - an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!

keyPress

public void keyPress(ElementLocator<?> elementLocator,
                     String keySequence)

Description copied from interface: TypedSelenium

Simulates a user pressing and releasing a key.

Specified by:: keyPress in interface TypedSelenium

Parameters:: elementLocator - 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".

keyPressNative

public void keyPressNative(String keycode)

Description copied from interface: TypedSelenium

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.

Specified by:: keyPressNative in interface TypedSelenium

Parameters:: keycode - an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!

keyUp

public void keyUp(ElementLocator<?> elementLocator,
                  String keySequence)

Description copied from interface: TypedSelenium

Simulates a user releasing a key.

Specified by:: keyUp in interface TypedSelenium

Parameters:: elementLocator - 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".

keyUpNative

public void keyUpNative(String keycode)

Description copied from interface: TypedSelenium

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.

Specified by:: keyUpNative in interface TypedSelenium

Parameters:: keycode - an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!

logToBrowser

public void logToBrowser(String textToLog)

Description copied from interface: TypedSelenium

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

Specified by:: logToBrowser in interface TypedSelenium

Parameters:: textToLog - the message to be sent to the browser

metaKeyDown

public void metaKeyDown()

Description copied from interface: TypedSelenium

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

Specified by:: metaKeyDown in interface TypedSelenium

metaKeyUp

public void metaKeyUp()

Description copied from interface: TypedSelenium

Release the meta key.

Specified by:: metaKeyUp in interface TypedSelenium

mouseDown

public void mouseDown(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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

Specified by:: mouseDown in interface TypedSelenium

Parameters:: elementLocator - an element locator

mouseDownAt

public void mouseDownAt(ElementLocator<?> elementLocator,
                        Point point)

Description copied from interface: TypedSelenium

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

Specified by:: mouseDownAt in interface TypedSelenium

Parameters:: elementLocator - an element locator

mouseDownRight

public void mouseDownRight(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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

Specified by:: mouseDownRight in interface TypedSelenium

Parameters:: elementLocator - an element locator

mouseDownRightAt

public void mouseDownRightAt(ElementLocator<?> elementLocator,
                             Point point)

Description copied from interface: TypedSelenium

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

Specified by:: mouseDownRightAt in interface TypedSelenium

Parameters:: elementLocator - an element locator

mouseMove

public void mouseMove(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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

Specified by:: mouseMove in interface TypedSelenium

Parameters:: elementLocator - an element locator

mouseMoveAt

public void mouseMoveAt(ElementLocator<?> elementLocator,
                        Point point)

Description copied from interface: TypedSelenium

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

Specified by:: mouseMoveAt in interface TypedSelenium

Parameters:: elementLocator - an element locator

mouseOut

public void mouseOut(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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

Specified by:: mouseOut in interface TypedSelenium

Parameters:: elementLocator - an element locator

mouseOver

public void mouseOver(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

Simulates a user hovering a mouse over the specified element.

Specified by:: mouseOver in interface TypedSelenium

Parameters:: elementLocator - an element locator

mouseUp

public void mouseUp(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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

Specified by:: mouseUp in interface TypedSelenium

Parameters:: elementLocator - an element locator

mouseUpAt

public void mouseUpAt(ElementLocator<?> elementLocator,
                      Point point)

Description copied from interface: TypedSelenium

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

Specified by:: mouseUpAt in interface TypedSelenium

Parameters:: elementLocator - an element locator

mouseUpRight

public void mouseUpRight(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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

Specified by:: mouseUpRight in interface TypedSelenium

Parameters:: elementLocator - an element locator

mouseUpRightAt

public void mouseUpRightAt(ElementLocator<?> elementLocator,
                           Point point)

Description copied from interface: TypedSelenium

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

Specified by:: mouseUpRightAt in interface TypedSelenium

Parameters:: elementLocator - an element locator

open

public void open(URL url)

Description copied from interface: TypedSelenium

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 TypedSelenium

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

openWindow

public void openWindow(URL url,
                       WindowId windowID)

Description copied from interface: UnsupportedTypedSelenium

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 UnsupportedTypedSelenium

Parameters:: url - the URL to open, which can be blank; windowID - the JavaScript window ID of the window to select

refresh

public void refresh()

Description copied from interface: TypedSelenium

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

Specified by:: refresh in interface TypedSelenium

removeAllSelections

public void removeAllSelections(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

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

Specified by:: removeAllSelections in interface TypedSelenium

Parameters:: elementLocator - an element locator identifying a multi-select box

removeScript

public void removeScript(JavaScript javaScript)

Description copied from interface: TypedSelenium

Removes a script tag from the Selenium document identified by the JavaScript's id (see JavaScript.getIdentification(). Does nothing if the referenced tag doesn't exist.

Specified by:: removeScript in interface TypedSelenium

Parameters:: javaScript - JavaScript we want to remove

removeSelection

public void removeSelection(ElementLocator<?> elementLocator,
                            OptionLocator<?> optionLocator)

Description copied from interface: TypedSelenium

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

Specified by:: removeSelection in interface TypedSelenium

Parameters:: elementLocator - an element locator identifying a multi-select box; optionLocator - an option locator (a label by default)
See Also:: for details of option locators

retrieveLastRemoteControlLogs

public String retrieveLastRemoteControlLogs()

Description copied from interface: TypedSelenium

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.

Specified by:: retrieveLastRemoteControlLogs in interface TypedSelenium

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

runScript

public void runScript(JavaScript script)

Description copied from interface: TypedSelenium

Creates a new "script" tag in the body of the current test window, and adds the specified text into the body of the command. Scripts run in this way can often be debugged more easily than scripts executed using Selenium's "getEval" command. Beware that JS exceptions thrown in these script tags aren't managed by Selenium, so you should probably wrap your script in try/catch blocks if there is any chance that the script will throw an exception.

Specified by:: runScript in interface TypedSelenium

Parameters:: script - the JavaScript snippet to run

select

public void select(ElementLocator<?> selectLocator,
                   OptionLocator<?> optionLocator)

Description copied from interface: TypedSelenium

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 TypedSelenium

Parameters:: selectLocator - an element locator identifying a drop-down menu; optionLocator - an option locator (a label by default)

selectFrame

public void selectFrame(FrameLocator frameLocator)

Description copied from interface: TypedSelenium

Selects a frame within the current window. (You may invoke this command multiple times to select nested frames.) To select the parent frame, use FrameLocator.PARENT; to select the top frame, use FrameLocator.TOP. You can also select a frame by its 0-based index number (construct own FrameLocator using notation described in Selenium.selectFrame(String)).

You may also use a DOM expression to identify the frame you want directly, like this: dom=frames["main"].frames["subframe"] (construct own FrameLocator using notation described in Selenium.selectFrame(String)).

Specified by:: selectFrame in interface TypedSelenium

Parameters:: frameLocator - an frame locator identifying a frame or iframe

selectPopUp

public void selectPopUp(WindowId windowID)

Description copied from interface: UnsupportedTypedSelenium

Simplifies the process of selecting a popup window (and does not offer functionality beyond what selectWindow() already provides).

If windowID 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; and 3) the title of the window. This is the same ordered lookup performed by selectWindow .

Specified by:: selectPopUp in interface UnsupportedTypedSelenium

Parameters:: windowID - an identifier for the popup window, which can take on a number of different meanings

selectWindow

public void selectWindow(WindowId windowID)

Description copied from interface: UnsupportedTypedSelenium

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

Specified by:: selectWindow in interface UnsupportedTypedSelenium

Parameters:: windowID - the JavaScript window ID of the window to select

setBrowserLogLevel

public void setBrowserLogLevel(LogLevel logLevel)

Description copied from interface: TypedSelenium

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.

Specified by:: setBrowserLogLevel in interface TypedSelenium

Parameters:: logLevel - one of the following: "debug", "info", "warn", "error" or "off"

setCursorPosition

public void setCursorPosition(ElementLocator<?> elementLocator,
                              int position)

Description copied from interface: TypedSelenium

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.

Specified by:: setCursorPosition in interface TypedSelenium

Parameters:: elementLocator - an element locator pointing to an input element or textarea; 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.

setExtensionJs

public void setExtensionJs(JavaScript extensionJs)

Description copied from interface: UnsupportedTypedSelenium

Sets the per-session extension Javascript

Specified by:: setExtensionJs in interface UnsupportedTypedSelenium

setMouseSpeed

public void setMouseSpeed(int pixels)

Description copied from interface: TypedSelenium

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.

Specified by:: setMouseSpeed in interface TypedSelenium

Parameters:: pixels - the number of pixels between "mousemove" events

setSpeed

public void setSpeed(long speedInMilis)

Description copied from interface: TypedSelenium

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 TypedSelenium

setTimeout

public void setTimeout(long timeoutInMilis)

Description copied from interface: TypedSelenium

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.

Specified by:: setTimeout in interface TypedSelenium

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

shiftKeyDown

public void shiftKeyDown()

Description copied from interface: TypedSelenium

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

Specified by:: shiftKeyDown in interface TypedSelenium

shiftKeyUp

public void shiftKeyUp()

Description copied from interface: TypedSelenium

Release the shift key.

Specified by:: shiftKeyUp in interface TypedSelenium

shutDownSeleniumServer

public void shutDownSeleniumServer()

Description copied from interface: TypedSelenium

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.

Specified by:: shutDownSeleniumServer in interface TypedSelenium

start

public void start()

Description copied from interface: TypedSelenium

Launches the browser with a new Selenium session

Specified by:: start in interface TypedSelenium

stop

public void stop()

Description copied from interface: TypedSelenium

Ends the test session, killing the browser

Specified by:: stop in interface TypedSelenium

submit

public void submit(ElementLocator<?> formLocator)

Description copied from interface: TypedSelenium

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

Specified by:: submit in interface TypedSelenium

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

type

public void type(ElementLocator<?> elementLocator,
                 String value)

Description copied from interface: TypedSelenium

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 TypedSelenium

Parameters:: elementLocator - an element locator; value - the value to type

typeKeys

public void typeKeys(ElementLocator<?> elementLocator,
                     String value)

Description copied from interface: TypedSelenium

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.

Specified by:: typeKeys in interface TypedSelenium

Parameters:: elementLocator - an element locator; value - the value to type

uncheck

public void uncheck(ElementLocator<?> elementLocator)

Description copied from interface: TypedSelenium

Uncheck a toggle-button (checkbox/radio)

Specified by:: uncheck in interface TypedSelenium

Parameters:: elementLocator - an element locator

useXpathLibrary

public void useXpathLibrary(XpathLibrary xpathLibrary)

Description copied from interface: TypedSelenium

Allows choice of one of the available libraries.

Specified by:: useXpathLibrary in interface TypedSelenium

Parameters:

xpathLibrary - name of the desired library Only the following three can be chosen:

"ajaxslt" - Google's library
"javascript-xpath" - Cybozu Labs' faster library
"default" - The default library. Currently the default library is "ajaxslt" .

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

waitForCondition

public void waitForCondition(JavaScript script)

Description copied from interface: TypedSelenium

Runs the specified JavaScript snippet repeatedly until it evaluates to "true". The snippet may have multiple lines, but only the result of the last line will be considered.

Note that, by default, the snippet will be run in the runner's test window, not in the window of your application. To get the window of your application, you can use the JavaScript snippet selenium.browserbot.getCurrentWindow(), and then run your JavaScript in there

Wait default timeout specified in (org.jboss.test.selenium.SystemProperties.SeleniumTimeoutType) of type SystemProperties.SeleniumTimeoutType#DEFAULT.

Specified by:: waitForCondition in interface TypedSelenium

Parameters:: script - the JavaScript snippet to run

waitForCondition

public void waitForCondition(JavaScript script,
                             long timeout)

Description copied from interface: TypedSelenium

Runs the specified JavaScript snippet repeatedly until it evaluates to "true". The snippet may have multiple lines, but only the result of the last line will be considered.

Specified by:: waitForCondition in interface TypedSelenium

Parameters:: script - the JavaScript snippet to run; timeout - a timeout in milliseconds, after which this command will return with an error

waitForFrameToLoad

public void waitForFrameToLoad(URL frameURL)

Description copied from interface: TypedSelenium

Waits for a new frame to load.

Selenium constantly keeps track of new pages and frames loading, and sets a "newPageLoaded" flag when it first notices a page load.

See waitForPageToLoad for more information.

Wait default timeout specified in (org.jboss.test.selenium.SystemProperties.SeleniumTimeoutType) of type SystemProperties.SeleniumTimeoutType.DEFAULT.

Specified by:: waitForFrameToLoad in interface TypedSelenium

Parameters:: frameURL - FrameAddress from the server side

waitForFrameToLoad

public void waitForFrameToLoad(URL frameURL,
                               long timeout)

Description copied from interface: TypedSelenium

Waits for a new frame to load.

Selenium constantly keeps track of new pages and frames loading, and sets a "newPageLoaded" flag when it first notices a page load.

See waitForPageToLoad for more information.

Specified by:: waitForFrameToLoad in interface TypedSelenium

Parameters:: frameURL - FrameAddress from the server side; timeout - a timeout in milliseconds, after which this command will return with an error

waitForPageToLoad

public void waitForPageToLoad()

Description copied from interface: TypedSelenium

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.

Wait default timeout specified in (org.jboss.test.selenium.SystemProperties.SeleniumTimeoutType) of type SystemProperties.SeleniumTimeoutType.DEFAULT.

Specified by:: waitForPageToLoad in interface TypedSelenium

waitForPageToLoad

public void waitForPageToLoad(long timeout)

Description copied from interface: TypedSelenium

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

Specified by:: waitForPageToLoad in interface TypedSelenium

Parameters:: timeout - a timeout in milliseconds, after which this command will return with an error

waitForPopUp

public void waitForPopUp(WindowId windowId,
                         long timeoutInMilis)

Description copied from interface: UnsupportedTypedSelenium

Waits for a popup window to appear and load up.

Specified by:: waitForPopUp in interface UnsupportedTypedSelenium

windowFocus

public void windowFocus()

Description copied from interface: TypedSelenium

Gives focus to the currently selected window

Specified by:: windowFocus in interface TypedSelenium

windowMaximize

public void windowMaximize()

Description copied from interface: TypedSelenium

Resize currently selected window to take up the entire screen

Specified by:: windowMaximize in interface TypedSelenium

getAllCookies

public Set<Cookie> getAllCookies()

Description copied from interface: TypedSelenium

Return all cookies of the current page under test.

Currently unsupported

Specified by:: getAllCookies in interface TypedSelenium

Returns:: all cookies of the current page under test

getCookieByName

public Cookie getCookieByName(String cookieName)

Description copied from interface: TypedSelenium

Returns the value of the cookie with the specified name, or throws an error if the cookie is not present.

Specified by:: getCookieByName in interface TypedSelenium

Parameters:: cookieName - the name of the cookie
Returns:: the value of the cookie

isCookiePresent

public boolean isCookiePresent(String cookieName)

Description copied from interface: TypedSelenium

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

Specified by:: isCookiePresent in interface TypedSelenium

Parameters:: cookieName - the name of the cookie
Returns:: true if a cookie with the specified name is present, or false otherwise.

createCookie

public void createCookie(Cookie cookie)

Description copied from interface: TypedSelenium

Create a new cookie whose path and domain are same with those of current page under test.

Specified by:: createCookie in interface TypedSelenium

Parameters:: cookie - the cookie to be created

createCookie

public void createCookie(Cookie cookie,
                         CreateCookieOptions options)

Description copied from interface: TypedSelenium

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

Specified by:: createCookie in interface TypedSelenium

Parameters:: cookie - the cookie to be created; options - options for the cookie. Currently supported options include 'path', 'max_age' and 'domain'. the optionsString's format is "path=/path/, max_age=60, domain=.foo.com". The order of options are irrelevant, the unit of the value of 'max_age' is second. Note that specifying a domain that isn't a subset of the current domain will usually fail.

deleteCookie

public void deleteCookie(String cookieName,
                         DeleteCookieOptions options)

Description copied from interface: TypedSelenium

Delete a named cookie with specified options. Be careful; to delete a cookie, you need to delete it using the exact same path and domain that were used to create the cookie. If the path is wrong, or the domain is wrong, the cookie simply won't be deleted. Also note that specifying a domain that isn't a subset of the current domain will usually fail. Since there's no way to discover at runtime the original path and domain of a given cookie, we've added an option called 'recurse' to try all sub-domains of the current domain with all paths that are a subset of the current path. Beware; this option can be slow. In big-O notation, it operates in O(n*m) time, where n is the number of dots in the domain name and m is the number of slashes in the path.

Specified by:: deleteCookie in interface TypedSelenium

Parameters:: cookieName - the name of the cookie to be deleted; options - options for the cookie. Currently supported options include 'path', 'domain' and 'recurse.' The optionsString's format is "path=/path/, domain=.foo.com, recurse=true". The order of options are irrelevant. Note that specifying a domain that isn't a subset of the current domain will usually fail.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.test.selenium.framework Class TypedSeleniumImpl

TypedSeleniumImpl

addCustomRequestHeader

addLocationStrategy

addScript

addSelection

allowNativeXpath

altKeyDown

altKeyUp

answerOnNextPrompt

assignId

attachFile

attachFile

captureEntirePageScreenshot

captureEntirePageScreenshot

captureNetworkTraffic

captureScreenshot

captureScreenshot

check

chooseCancelOnNextConfirmation

chooseOkOnNextConfirmation

click

clickAt

close

containsScript

contextMenu

contextMenuAt

controlKeyDown

controlKeyUp

deleteAllVisibleCookies

deselectPopUp

doubleClick

doubleClickAt

dragAndDrop

dragAndDropToObject

dragdrop

fireEvent

focus

getAlert

getAllButtons

getAllFields

getAllLinks

getAllWindowIds

getAllWindowNames

getAllWindowTitles

getAttribute

getAttributeFromAllWindows

getBodyText

getConfirmation

getCount

getCursorPosition

getElementDimension

getElementHeight

getElementIndex

getElementPosition

getElementPositionLeft

getElementPositionTop

getElementWidth

getEval

getExpression

getHtmlSource

getLocation

getMouseSpeed

getPrompt

getSelectOptions

getSelectedId

getSelectedIds

getSelectedIndex

getSelectedIndexes

getSelectedLabel

getSelectedLabels

getSelectedValue

getSelectedValues

getSpeed

getText

getTitle

getValue

getWhetherThisFrameMatchFrameExpression

getWhetherThisWindowMatchWindowExpression

goBack

org.jboss.test.selenium.framework
Class TypedSeleniumImpl