org.safs.selenium.webdriver.lib

Class SearchObject.DefaultJSEventListener

java.lang.Object

org.safs.selenium.webdriver.lib.SearchObject.DefaultJSEventListener

All Implemented Interfaces:

SearchObject.GenericJSEventListener

Enclosing class:

SearchObject

protected static class SearchObject.DefaultJSEventListener
extends java.lang.Object
implements SearchObject.GenericJSEventListener

A default javascript event listener.
Usage example:

 String event = "mousedown";
 int timeout = 1000;//milliseconds
 DefaultJSEventListener listener = new DefaultJSEventListener(event);
 //add listener for event
 String listenerID = WDLibrary.addJavaScriptEventListener(webelement, event, listener);
 //do some mousedown related work, for example 'click'
 webelement.click();
 //wait for event happen
 if(listener.waitEventFired(timeout)){ //ok, event has been fired.}
 //remove the listener
 WDLibrary.removeJavaScriptEventListener(webelement, event, listenerID);
 

History:

Apr 15, 2014 (Lei Wang) Initial release.

See Also:

SearchObject.addJavaScriptEventListener(WebElement, String, GenericJSEventListener)

Field Summary

Fields inherited from interface org.safs.selenium.webdriver.lib.SearchObject.GenericJSEventListener

EVENT_JS_click, EVENT_JS_MOUSEDOWN, EVENT_JS_MOUSEUP, TIMEOUT_WAIT_FOR_EVENT_MOUSEDOWN

Constructor Summary

Constructors

Constructor and Description
DefaultJSEventListener()
DefaultJSEventListener(java.lang.String eventName)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEventName()
boolean	isEventFired()
void	onEventFired()
void	setEventFired(boolean eventFired)
void	setEventName(java.lang.String eventName)
boolean	waitEventFired(long timeout)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJSEventListener

public DefaultJSEventListener()

DefaultJSEventListener

public DefaultJSEventListener(java.lang.String eventName)

Method Detail

isEventFired

public boolean isEventFired()

setEventFired

public void setEventFired(boolean eventFired)

getEventName

public java.lang.String getEventName()

setEventName

public void setEventName(java.lang.String eventName)

onEventFired

public void onEventFired()

Specified by:

onEventFired in interface SearchObject.GenericJSEventListener

waitEventFired

public boolean waitEventFired(long timeout)

Parameters:

timeout - long, time to wait for the event fired. in milliseconds.

Returns:

boolean true if the event has been fired within timeout; false otherwise.