TypedSelenium (Ajocado API 1.0.0.Alpha2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Ajocado API 1.0.0.Alpha2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.arquillian.ajocado.framework
Interface TypedSelenium

All Known Subinterfaces:: AjaxSelenium, ExtendedTypedSelenium

public interface TypedSelenium

The type-safe wrapper for Selenium API.

Version:: $Revision$
Author:: Lukas Fryc

Method Summary
`void`	`addCustomRequestHeader(RequestHeader header)` Tells the Selenium server to add the specificed key and value as a custom outgoing request header.
`void`	`addLocationStrategy(ElementLocationStrategy strategyName, JavaScript functionDefinition)` 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<?> locator, 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()].
`ElementLocator<?>`	`assignId(ElementLocator<?> locator, 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.
`BufferedImage`	`captureEntirePageScreenshot()` Downloads a screenshot of the browser current window canvas to a based 64 encoded 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`	`check(ElementLocator<?> locator)` Check a toggle-button (checkbox/radio)
`void`	`chooseCancelOnNextConfirmation()` By default, Selenium's overridden window.confirm() function will return true, as if the user had manually clicked OK; 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<?> locator)` Clicks on a link, button, checkbox or radio button.
`void`	`clickAt(ElementLocator<?> locator, Point coords)` 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<?> locator)` Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
`void`	`contextMenuAt(ElementLocator<?> locator, Point coords)` 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<?> locator)` Double clicks on a link, button, checkbox or radio button.
`void`	`doubleClickAt(ElementLocator<?> locator, Point coords)` Doubleclicks on a link, button, checkbox or radio button.
`void`	`dragAndDrop(ElementLocator<?> locator, Offset movementsString)` Drags an element a certain distance and then drops it
`void`	`dragAndDropToObject(ElementLocator<?> locatorOfObjectToBeDragged, ElementLocator<?> locatorOfDragDestinationObject)` Drags an element and drops it on another element
`void`	`dragdrop(ElementLocator<?> locator, Offset movementsString)` deprecated - use dragAndDrop instead
`void`	`fireEvent(ElementLocator<?> locator, Event event)` Explicitly simulate an event, to trigger the corresponding handler.
`void`	`focus(ElementLocator<?> locator)` 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.
`Set<Cookie>`	`getAllCookies()` Return all cookies of the current page under test.
`String`	`getAttribute(AttributeLocator<?> attributeLocator)` Gets the value of an element attribute.
`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<?> locator)` Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers.
`Dimension`	`getElementDimension(ElementLocator<?> locator)` Retrievers the element dimensions (width, height)
`int`	`getElementHeight(ElementLocator<?> locator)` Retrieves the height of an element
`int`	`getElementIndex(ElementLocator<?> locator)` Get the relative index of an element to its parent (starting from 0).
`Point`	`getElementPosition(ElementLocator<?> locator)` Retrieves the position of an element
`int`	`getElementPositionLeft(ElementLocator<?> locator)` Retrieves the horizontal position of an element
`int`	`getElementPositionTop(ElementLocator<?> locator)` Retrieves the vertical position of an element
`int`	`getElementWidth(ElementLocator<?> locator)` Retrieves the width of an element
`String`	`getEval(JavaScript script)` Gets the result of evaluating the specified JavaScript snippet.
`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<?> locator)` Gets the text of an element.
`String`	`getTitle()` Gets the title of the current page.
`String`	`getValue(ElementLocator<?> locator)` Gets the (whitespace-trimmed) value of an input field (or anything else with a value parameter).
`void`	`goBack()` Simulates the user clicking the "back" button on their browser.
`void`	`highlight(ElementLocator<?> locator)` 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<?> locator)` 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<?> locator)` Determines whether the specified input element is editable, ie hasn't been disabled.
`boolean`	`isElementPresent(ElementLocator<?> locator)` Verifies that the specified element is somewhere on the page.
`boolean`	`isOrdered(ElementLocator<?> locator1, ElementLocator<?> locator2)` 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<?> locator)` Determines if the specified element is visible.
`void`	`keyDown(ElementLocator<?> locator, 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<?> locator, 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<?> locator, 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 context)` 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<?> locator)` Simulates a user pressing the left mouse button (without releasing it yet) on the specified element.
`void`	`mouseDownAt(ElementLocator<?> locator, Point coords)` Simulates a user pressing the left mouse button (without releasing it yet) at the specified location.
`void`	`mouseDownRight(ElementLocator<?> locator)` Simulates a user pressing the right mouse button (without releasing it yet) on the specified element.
`void`	`mouseDownRightAt(ElementLocator<?> locator, Point coords)` Simulates a user pressing the right mouse button (without releasing it yet) at the specified location.
`void`	`mouseMove(ElementLocator<?> locator)` Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
`void`	`mouseMoveAt(ElementLocator<?> locator, Point coords)` Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
`void`	`mouseOut(ElementLocator<?> locator)` Simulates a user moving the mouse pointer away from the specified element.
`void`	`mouseOver(ElementLocator<?> locator)` Simulates a user hovering a mouse over the specified element.
`void`	`mouseUp(ElementLocator<?> locator)` 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<?> locator, Point coords)` 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<?> locator)` Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) on the specified element.
`void`	`mouseUpRightAt(ElementLocator<?> locator, Point coords)` 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`	`refresh()` Simulates the user clicking the "Refresh" button on their browser.
`void`	`removeAllSelections(ElementLocator<?> locator)` 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<?> locator, 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`	`setBrowserLogLevel(LogLevel logLevel)` Sets the threshold for browser-side logging messages; log messages beneath this threshold will be discarded.
`void`	`setCursorPosition(ElementLocator<?> locator, int position)` Moves the text cursor to the specified position in the given input element or textarea.
`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 timeout)` Specifies the amount of time that Selenium will wait for actions to complete.
`void`	`shiftKeyDown()` Press the shift key and hold it down until doShiftUp() is called or a new page is loaded.
`void`	`shiftKeyUp()` Release the shift key.
`void`	`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<?> locator, String value)` Sets the value of an input field, as though you typed it in.
`void`	`typeKeys(ElementLocator<?> locator, String value)` Simulates keystroke events on the specified element, as though you typed the value key-by-key.
`void`	`uncheck(ElementLocator<?> locator)` 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 frameAddress)` Waits for a new frame to load.
`void`	`waitForFrameToLoad(URL frameAddress, 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`	`windowFocus()` Gives focus to the currently selected window
`void`	`windowMaximize()` Resize currently selected window to take up the entire screen

Method Detail

start

void start()

Launches the browser with a new Selenium session

stop

void stop()

Ends the test session, killing the browser

click

void click(ElementLocator<?> locator)

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

Parameters:: locator - an element locator

doubleClick

void doubleClick(ElementLocator<?> locator)

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

Parameters:: locator - an element locator

contextMenu

void contextMenu(ElementLocator<?> locator)

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

Parameters:: locator - an element locator

clickAt

void clickAt(ElementLocator<?> locator,
             Point coords)

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

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

doubleClickAt

void doubleClickAt(ElementLocator<?> locator,
                   Point coords)

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

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

contextMenuAt

void contextMenuAt(ElementLocator<?> locator,
                   Point coords)

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

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

fireEvent

void fireEvent(ElementLocator<?> locator,
               Event event)

Explicitly simulate an event, to trigger the corresponding handler.

Parameters:: locator - an element locator; event - the event name, e.g. "focus" or "blur"

focus

void focus(ElementLocator<?> locator)

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

Parameters:: locator - an element locator

keyPress

void keyPress(ElementLocator<?> locator,
              String keySequence)

Simulates a user pressing and releasing a key.

Parameters:: locator - an element locator; keySequence - Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: " w", "\119".

shiftKeyDown

void shiftKeyDown()

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

shiftKeyUp

void shiftKeyUp()

Release the shift key.

metaKeyDown

void metaKeyDown()

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

metaKeyUp

void metaKeyUp()

Release the meta key.

altKeyDown

void altKeyDown()

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

altKeyUp

void altKeyUp()

Release the alt key.

controlKeyDown

void controlKeyDown()

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

controlKeyUp

void controlKeyUp()

Release the control key.

keyDown

void keyDown(ElementLocator<?> locator,
             String keySequence)

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

Parameters:: locator - an element locator; keySequence - Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: " w", "\119".

keyUp

void keyUp(ElementLocator<?> locator,
           String keySequence)

Simulates a user releasing a key.

Parameters:: locator - an element locator; keySequence - Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: " w", "\119".

mouseOver

void mouseOver(ElementLocator<?> locator)

Simulates a user hovering a mouse over the specified element.

Parameters:: locator - an element locator

mouseOut

void mouseOut(ElementLocator<?> locator)

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

Parameters:: locator - an element locator

mouseDown

void mouseDown(ElementLocator<?> locator)

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

Parameters:: locator - an element locator

mouseDownRight

void mouseDownRight(ElementLocator<?> locator)

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

Parameters:: locator - an element locator

mouseDownAt

void mouseDownAt(ElementLocator<?> locator,
                 Point coords)

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

Parameters:: locator - an element locator; coords - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

mouseDownRightAt

void mouseDownRightAt(ElementLocator<?> locator,
                      Point coords)

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

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

mouseUp

void mouseUp(ElementLocator<?> locator)

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

Parameters:: locator - an element locator

mouseUpRight

void mouseUpRight(ElementLocator<?> locator)

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

Parameters:: locator - an element locator

mouseUpAt

void mouseUpAt(ElementLocator<?> locator,
               Point coords)

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

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

mouseUpRightAt

void mouseUpRightAt(ElementLocator<?> locator,
                    Point coords)

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

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

mouseMove

void mouseMove(ElementLocator<?> locator)

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

Parameters:: locator - an element locator

mouseMoveAt

void mouseMoveAt(ElementLocator<?> locator,
                 Point coords)

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

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

type

void type(ElementLocator<?> locator,
          String value)

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.

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

typeKeys

void typeKeys(ElementLocator<?> locator,
              String value)

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

This is a convenience method for calling keyDown, keyUp, keyPress for every character in the specified string; this is useful for dynamic UI widgets (like auto-completing combo boxes) that require explicit key events.

Unlike the simple "type" command, which forces the specified value into the page directly, this command may or may not have any visible effect, even in cases where typing keys would normally have a visible effect. For example, if you use "typeKeys" on a form element, you may or may not see the results of what you typed in the field.

In some cases, you may need to use the simple "type" command to set the value of the field and then the "typeKeys" command to send the keystroke events corresponding to what you just typed.

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

setSpeed

void setSpeed(long speedInMilis)

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

Parameters:: speedInMilis - the number of milliseconds to pause after operation

getSpeed

long getSpeed()

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

Returns:: the execution speed in milliseconds.

check

void check(ElementLocator<?> locator)

Check a toggle-button (checkbox/radio)

Parameters:: locator - an element locator

uncheck

void uncheck(ElementLocator<?> locator)

Uncheck a toggle-button (checkbox/radio)

Parameters:: locator - an element locator

select

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

Select an option from a drop-down using an option locator.

Option locators provide different ways of specifying options of an HTML Select element (e.g. for selecting a specific option, or for asserting that the selected option satisfies a specification). There are several forms of Select Option Locator.

label=labelPattern: matches options based on their labels, i.e. the visible text. (This is the default.)
- label=regexp:^[Oo]ther
value=valuePattern: matches options based on their values.
- value=other
id=id: matches options based on their ids.
- id=option1
index=index: matches an option based on its index (offset from zero).
- index=2

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

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

addSelection

void addSelection(ElementLocator<?> locator,
                  OptionLocator<?> optionLocator)

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

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

removeSelection

void removeSelection(ElementLocator<?> locator,
                     OptionLocator<?> optionLocator)

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

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

removeAllSelections

void removeAllSelections(ElementLocator<?> locator)

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

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

submit

void submit(ElementLocator<?> formLocator)

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

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

open

void open(URL url)

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

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

deselectPopUp

void deselectPopUp()

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

selectFrame

void selectFrame(FrameLocator frameLocator)

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 com.thoughtworks.selenium.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 com.thoughtworks.selenium.Selenium#selectFrame(String)).

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

chooseCancelOnNextConfirmation

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

chooseOkOnNextConfirmation

void chooseOkOnNextConfirmation()

Undo the effect of calling chooseCancelOnNextConfirmation. Note that Selenium's overridden window.confirm() function will normally automatically return true, as if the user had manually clicked OK, so you shouldn't need to use this command unless for some reason you need to change your mind prior to the next confirmation. After any confirmation, Selenium will resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call chooseCancelOnNextConfirmation for each confirmation.

Take note - every time a confirmation comes up, you must consume it with a corresponding getConfirmation, or else the next selenium operation will fail.

answerOnNextPrompt

void answerOnNextPrompt(String answer)

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

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

goBack

void goBack()

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

refresh

void refresh()

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

close

void close()

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

isAlertPresent

boolean isAlertPresent()

Has an alert occurred?

This function never throws an exception

Returns:: true if there is an alert

isPromptPresent

boolean isPromptPresent()

Has a prompt occurred?

This function never throws an exception

Returns:: true if there is a pending prompt

isConfirmationPresent

boolean isConfirmationPresent()

Has confirm() been called?

This function never throws an exception

Returns:: true if there is a pending confirmation

getAlert

String getAlert()

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

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

Under Selenium, JavaScript alerts will NOT pop up a visible alert dialog.

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

Returns:: The message of the most recent JavaScript alert

getConfirmation

String getConfirmation()

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

By default, the confirm function will return true, having the same effect as manually clicking OK. This can be changed by prior execution of the chooseCancelOnNextConfirmation command.

If an confirmation is generated but you do not consume it with getConfirmation, the next Selenium action will fail.

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

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

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

getPrompt

String getPrompt()

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.

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

getLocation

URL getLocation()

Gets the absolute URL of the current page.

Returns:: the absolute URL of the current page

getTitle

String getTitle()

Gets the title of the current page.

Returns:: the title of the current page

getBodyText

String getBodyText()

Gets the entire text of the page.

Returns:: the entire text of the page

getValue

String getValue(ElementLocator<?> locator)

Gets the (whitespace-trimmed) value of an input field (or anything else with a value parameter). For checkbox/radio elements, the value will be "on" or "off" depending on whether the element is checked or not.

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

getText

String getText(ElementLocator<?> locator)

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

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

highlight

void highlight(ElementLocator<?> locator)

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

Parameters:: locator - an element locator

getEval

String getEval(JavaScript script)

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

Note that, by default, the snippet will run in the context of the "selenium" object itself, so this will refer to the Selenium object. Use window to refer to the window of your application, e.g. window.document.getElementById('foo')

If you need to use a locator to refer to a single element in your application page, you can use this.browserbot.findElement("id=foo") where "id=foo" is your locator.

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

isChecked

boolean isChecked(ElementLocator<?> locator)

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

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

getSelectedLabels

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

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

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

getSelectedLabel

String getSelectedLabel(ElementLocator<?> selectLocator)

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

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

getSelectedValues

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

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

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

getSelectedValue

String getSelectedValue(ElementLocator<?> selectLocator)

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

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

getSelectedIndexes

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.

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

getSelectedIndex

int getSelectedIndex(ElementLocator<?> selectLocator)

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

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

getSelectedIds

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

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

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

getSelectedId

String getSelectedId(ElementLocator<?> selectLocator)

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

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

isSomethingSelected

boolean isSomethingSelected(ElementLocator<?> selectLocator)

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

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

getSelectOptions

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

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

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

getAttribute

String getAttribute(AttributeLocator<?> attributeLocator)

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

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

isTextPresent

boolean isTextPresent(String text)

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

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

isElementPresent

boolean isElementPresent(ElementLocator<?> locator)

Verifies that the specified element is somewhere on the page.

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

isVisible

boolean isVisible(ElementLocator<?> locator)

Determines if the specified element is visible. An element can be rendered invisible by setting the CSS "visibility" property to "hidden", or the "display" property to "none", either for the element itself or one if its ancestors. This method will fail if the element is not present.

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

isEditable

boolean isEditable(ElementLocator<?> locator)

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

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

dragdrop

void dragdrop(ElementLocator<?> locator,
              Offset movementsString)

deprecated - use dragAndDrop instead

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

setMouseSpeed

void setMouseSpeed(int pixels)

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

Setting this value to 0 means that we'll send a "mousemove" event to every single pixel in between the start location and the end location; that can be very slow, and may cause some browsers to force the JavaScript to timeout.

If the mouse speed is greater than the distance between the two dragged objects, we'll just send one "mousemove" at the start location and then one final one at the end location.

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

getMouseSpeed

int getMouseSpeed()

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

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

dragAndDrop

void dragAndDrop(ElementLocator<?> locator,
                 Offset movementsString)

Drags an element a certain distance and then drops it

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

dragAndDropToObject

void dragAndDropToObject(ElementLocator<?> locatorOfObjectToBeDragged,
                         ElementLocator<?> locatorOfDragDestinationObject)

Drags an element and drops it on another element

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

windowFocus

void windowFocus()

Gives focus to the currently selected window

windowMaximize

void windowMaximize()

Resize currently selected window to take up the entire screen

getHtmlSource

String getHtmlSource()

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

Returns:: the entire HTML source

setCursorPosition

void setCursorPosition(ElementLocator<?> locator,
                       int position)

Moves the text cursor to the specified position in the given input element or textarea. This method will fail if the specified element isn't an input element or textarea.

Parameters:: locator - 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.

getElementIndex

int getElementIndex(ElementLocator<?> locator)

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

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

isOrdered

boolean isOrdered(ElementLocator<?> locator1,
                  ElementLocator<?> locator2)

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

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

getElementPositionLeft

int getElementPositionLeft(ElementLocator<?> locator)

Retrieves the horizontal position of an element

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

getElementPositionTop

int getElementPositionTop(ElementLocator<?> locator)

Retrieves the vertical position of an element

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

getElementPosition

Point getElementPosition(ElementLocator<?> locator)

Retrieves the position of an element

Parameters:: locator -
Returns:: the position in the current frame

getElementWidth

int getElementWidth(ElementLocator<?> locator)

Retrieves the width of an element

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

getElementHeight

int getElementHeight(ElementLocator<?> locator)

Retrieves the height of an element

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

getElementDimension

Dimension getElementDimension(ElementLocator<?> locator)

Retrievers the element dimensions (width, height)

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

getCursorPosition

int getCursorPosition(ElementLocator<?> locator)

Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers.

Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to return the position of the last location of the cursor, even though the cursor is now gone from the page. This is filed as SEL-243.

This method will fail if the specified element isn't an input element or textarea, or there is no cursor in the element.

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

getCount

int getCount(IterableLocator<?> locator)

Returns the number of elements that match the specified locator.

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

assignId

ElementLocator<?> assignId(ElementLocator<?> locator,
                           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. This ID will disappear once the page is reloaded.

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

allowNativeXpath

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. Using the pure-JS xpath library can improve the consistency of xpath element locators between different browser vendors, but the pure-JS version is much slower than the native implementations.

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

ignoreAttributesWithoutValue

void ignoreAttributesWithoutValue(boolean ignore)

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

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

waitForCondition

void waitForCondition(JavaScript script)

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.arquillian.ajocado.SystemProperties#getTimeout (org.jboss.arquillian.ajocado.TimeoutType.SeleniumTimeoutType of type TimeoutType.SeleniumTimeoutType#DEFAULT.

Parameters:: script - the JavaScript snippet to run

waitForCondition

void waitForCondition(JavaScript script,
                      long timeout)

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.

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

setTimeout

void setTimeout(long timeout)

Specifies the amount of time that Selenium will wait for actions to complete.

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

The default timeout is 30 seconds.

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

waitForPageToLoad

void waitForPageToLoad()

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.arquillian.ajocado.SystemProperties#getTimeout (org.jboss.arquillian.ajocado.TimeoutType.SeleniumTimeoutType) of type org.jboss.arquillian.ajocado.TimeoutType.SeleniumTimeoutType#DEFAULT.

waitForPageToLoad

void waitForPageToLoad(long timeout)

Waits for a new page to load.

You can use this command instead of the "AndWait" suffixes, "clickAndWait", "selectAndWait", "typeAndWait" etc. (which are only available in the JS API).

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

waitForFrameToLoad

void waitForFrameToLoad(URL frameAddress)

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.arquillian.ajocado.SystemProperties#getTimeout (org.jboss.arquillian.ajocado.TimeoutType.SeleniumTimeoutType)} of type org.jboss.arquillian.ajocado.TimeoutType.SeleniumTimeoutType#DEFAULT.

Parameters:: frameAddress - FrameAddress from the server side

waitForFrameToLoad

void waitForFrameToLoad(URL frameAddress,
                        long timeout)

Waits for a new frame to load.

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

See waitForPageToLoad for more information.

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

getAllCookies

Set<Cookie> getAllCookies()

Return all cookies of the current page under test.

Currently unsupported

Returns:: all cookies of the current page under test

getCookieByName

Cookie getCookieByName(String cookieName)

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

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

isCookiePresent

boolean isCookiePresent(String cookieName)

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

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

createCookie

void createCookie(Cookie cookie)

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

Parameters:: cookie - the cookie to be created

createCookie

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.

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

void deleteCookie(String cookieName,
                  DeleteCookieOptions options)

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.

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.

deleteAllVisibleCookies

void deleteAllVisibleCookies()

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

setBrowserLogLevel

void setBrowserLogLevel(LogLevel logLevel)

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

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

runScript

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

Parameters:: script - the JavaScript snippet to run

addLocationStrategy

void addLocationStrategy(ElementLocationStrategy strategyName,
                         JavaScript functionDefinition)

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

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

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

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

addScript

void addScript(JavaScript javaScript)

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.

Parameters:: javaScript - the JavaScript script to add

containsScript

boolean containsScript(JavaScript javaScript)

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

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

removeScript

void removeScript(JavaScript javaScript)

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.

Parameters:: javaScript - JavaScript we want to remove

useXpathLibrary

void useXpathLibrary(XpathLibrary xpathLibrary)

Allows choice of one of the available libraries.

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.

logToBrowser

void logToBrowser(String context)

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

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

shutDownSeleniumServer

void shutDownSeleniumServer()

Kills the running Selenium Server and all browser sessions. After you run this command, you will no longer be able to send commands to the server; you can't remotely start the server once it has been stopped. Normally you should prefer to run the "stop" command, which terminates the current browser session, rather than shutting down the entire server.

retrieveLastRemoteControlLogs

String retrieveLastRemoteControlLogs()

Retrieve the last messages logged on a specific remote control. Useful for error reports, especially when running multiple remote controls in a distributed environment. The maximum number of log messages that can be retrieve is configured on remote control startup.

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

keyDownNative

void keyDownNative(String keycode)

Simulates a user pressing a key (without releasing it yet) by sending a native operating system keystroke. This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command.

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

keyUpNative

void keyUpNative(String keycode)

Simulates a user releasing a key by sending a native operating system keystroke. This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command.

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

keyPressNative

void keyPressNative(String keycode)

Simulates a user pressing and releasing a key by sending a native operating system keystroke. This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command.

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

captureScreenshot

BufferedImage captureScreenshot()

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

Returns:: The BufferedImage

captureEntirePageScreenshot

BufferedImage captureEntirePageScreenshot()

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.

Returns:: The BufferedImage

captureNetworkTraffic

NetworkTraffic captureNetworkTraffic(NetworkTrafficType type)

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.

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.

addCustomRequestHeader

void addCustomRequestHeader(RequestHeader header)

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.

Parameters:: header - Header to be added

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Ajocado API 1.0.0.Alpha2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.arquillian.ajocado.framework Interface TypedSelenium

start

stop

click

doubleClick

contextMenu

clickAt

doubleClickAt

contextMenuAt

fireEvent

focus

keyPress

shiftKeyDown

shiftKeyUp

metaKeyDown

metaKeyUp

altKeyDown

altKeyUp

controlKeyDown

controlKeyUp

keyDown

keyUp

mouseOver

mouseOut

mouseDown

mouseDownRight

mouseDownAt

mouseDownRightAt

mouseUp

mouseUpRight

mouseUpAt

mouseUpRightAt

mouseMove

mouseMoveAt

type

typeKeys

setSpeed

getSpeed

check

uncheck

select

addSelection

removeSelection

removeAllSelections

submit

open

deselectPopUp

selectFrame

chooseCancelOnNextConfirmation

chooseOkOnNextConfirmation

answerOnNextPrompt

goBack

refresh

close

isAlertPresent

isPromptPresent

isConfirmationPresent

getAlert

getConfirmation

getPrompt

getLocation

getTitle

getBodyText

getValue

getText

highlight

getEval

isChecked

getSelectedLabels

getSelectedLabel

getSelectedValues

getSelectedValue

getSelectedIndexes

getSelectedIndex

getSelectedIds

getSelectedId

isSomethingSelected

getSelectOptions

getAttribute

isTextPresent

org.jboss.arquillian.ajocado.framework
Interface TypedSelenium