com.github.markusbernhardt.selenium2library.keywords

Class JavaScript

java.lang.Object

com.github.markusbernhardt.selenium2library.RunOnFailureKeywordsAdapter

com.github.markusbernhardt.selenium2library.keywords.JavaScript

All Implemented Interfaces:

RunOnFailureKeywords

public class JavaScript
extends RunOnFailureKeywordsAdapter

Field Summary

Fields

Modifier and Type	Field and Description
protected BrowserManagement	browserManagement Instantiated BrowserManagement keyword bean
protected boolean	cancelOnNextConfirmation
protected Logging	logging Instantiated Logging keyword bean

Constructor Summary

Constructors

Constructor and Description
JavaScript()

Method Summary

Methods

Modifier and Type	Method and Description
void	alertShouldBePresent()
void	alertShouldBePresent(String text) Verify an alert is present and dismiss it.
void	chooseCancelOnNextConfirmation() Cancel will be selected the next time a confirmation dialog appears.
void	chooseOkOnNextConfirmation() Undo the effect of using keywords `Choose Cancel On Next Confirmation`.
protected String	closeAlert()
protected String	closeAlert(boolean confirm)
String	confirmAction() Dismisses currently shown confirmation dialog and returns its message.
Object	executeAsyncJavascript(String... code) Execute the given JavaScript code asynchronously.
Object	executeJavascript(String... code) Execute the given JavaScript code.
String	getAlertMessage() Returns the text of current JavaScript alert.
protected String	getJavascriptToExecute(String code)
protected static String	readFile(String path)

Methods inherited from class com.github.markusbernhardt.selenium2library.RunOnFailureKeywordsAdapter

runOnFailureByAspectJ

Methods inherited from class java.lang.Object

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

Field Detail

browserManagement

protected BrowserManagement browserManagement

Instantiated BrowserManagement keyword bean

logging

protected Logging logging

Instantiated Logging keyword bean

cancelOnNextConfirmation

protected boolean cancelOnNextConfirmation

Constructor Detail

JavaScript

public JavaScript()

Method Detail

alertShouldBePresent

public void alertShouldBePresent()

alertShouldBePresent

public void alertShouldBePresent(String text)

Verify an alert is present and dismiss it.

If text is a non-empty string, then it is also verified that the message of the alert equals to text.

Will fail if no alert is present. Note that following keywords will fail unless the alert is dismissed by this keyword or another like `Get Alert Message`.

Parameters:

text - Default=NONE. The alert message to verify.

chooseCancelOnNextConfirmation

public void chooseCancelOnNextConfirmation()

Cancel will be selected the next time a confirmation dialog appears.

chooseOkOnNextConfirmation

public void chooseOkOnNextConfirmation()

Undo the effect of using keywords `Choose Cancel On Next Confirmation`.

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 use `Choose Cancel On Next Confirmation` for each confirmation.

Note that every time a confirmation comes up, you must consume it by using a keywords such as `Get Alert Message`, or else the following Selenium operations will fail.

confirmAction

public String confirmAction()

Dismisses currently shown confirmation dialog and returns its message.

By default, this keyword chooses 'OK' option from the dialog. If 'Cancel' needs to be chosen, keyword `Choose Cancel On Next Confirmation` must be called before the action that causes the confirmation dialog to be shown.

Example:

Click Button	Send		# Shows a confirmation dialog
${message}=	Confirm Action		# Chooses Ok
Should Be Equal	${message}	Are your sure?	# Check dialog message
Choose Cancel On Next Confirmation			# Choose cancel on next `Confirm Action`
Click Button	Send		# Shows a confirmation dialog
Confirm Action			# Chooses Cancel

Returns:

The dialog message.

executeJavascript

public Object executeJavascript(String... code)

Execute the given JavaScript code.

The given code may contain multiple lines of code, but must contain a return statement (with the value to be returned) at the end.

The given code may be divided into multiple cells in the test data. In that case, the parts are concatenated together without adding spaces. If the given code is an absolute path to an existing file, the JavaScript to execute will be read from that file. Forward slashes work as a path separator on all operating systems.

Note that by default the code will be executed 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').

Example:

Execute JavaScript	return window.my_js_function('arg1', 'arg2');	# Directly execute the JavaScript
Execute JavaScript	${CURDIR}/js_to_execute.js	# Load the JavaScript to execute from file

Parameters:

code - The JavaScript code or a file name.

Returns:

The return value of the executed code.

executeAsyncJavascript

public Object executeAsyncJavascript(String... code)

Execute the given JavaScript code asynchronously.

The given code may contain multiple lines of code, but must contain a return statement (with the value to be returned) at the end.

The given code may be divided into multiple cells in the test data. In that case, the parts are concatenated together without adding spaces. If the given code is an absolute path to an existing file, the JavaScript to execute will be read from that file. Forward slashes work as a path separator on all operating systems.

Note that by default the code will be executed 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').

Example:

Execute Async JavaScript	return window.my_js_function('arg1', 'arg2');	# Directly execute the JavaScript
Execute Async JavaScript	${CURDIR}/js_to_execute.js	# Load the JavaScript to execute from file

Parameters:

code - The JavaScript code or a file name.

Returns:

The return value of the executed code.

getAlertMessage

public String getAlertMessage()

Returns the text of current JavaScript alert.

This keyword will fail if no alert is present. Note that following keywords will fail unless the alert is dismissed by this keyword or another like `Get Alert Message`.

Returns:

The alert message.

closeAlert

protected String closeAlert()

closeAlert

protected String closeAlert(boolean confirm)

readFile

protected static String readFile(String path)
                          throws IOException

Throws:

IOException

getJavascriptToExecute

protected String getJavascriptToExecute(String code)