AsyncEvent (actiWATE - Web Application Testing Environment)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

version 1.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.actimind.actiwate.testing.events
Interface AsyncEvent

All Known Subinterfaces:: IntervalAsyncEvent, MetaRefreshAsyncEvent, TimeoutAsyncEvent, XmlHttpRequestAsyncEvent

public interface AsyncEvent

Base interface for all async events.
Async events are events that browser must execute after some time past their creation, these events can be IntervalAsyncEvents, TimeoutAsyncEvents, XmlHttpRequestAsyncEvents or MetaRefreshAsyncEvents.
Async events can be quered and/or executed using AsyncEvents object returned by ActiwateSession.getAsyncEvents() method call.
There are two modes of processing async events: automatic and not automatic. For more information on processing modes, see documentation for ActiwateSession.setExecAsyncEventsAutomatically(boolean) method.

Field Summary
`static int`	`INTERVAL` Timer(setInterval()) async event type code.
`static int`	`METAREFRESH` Meta refresh async event type code.
`static int`	`TIMEOUT` Timer(setTimeout()) async event type code.
`static int`	`XMLHTTPREQUEST` XmlHttpRequest async event type code.

Method Summary
`org.w3c.dom.Node`	`getOriginatingNode()` Returns originating node.
`Page`	`getPage()` Returns page which contains originating node returned by `getOriginatingNode()` method.
`long`	`getTimeOffset()` Returns offset in milliseconds after which the event should be executed.
`int`	`getType()` Returns async event type.
`boolean`	`isCancelled()` Returns value indicating whether or not this event was cancelled.
`boolean`	`isExecuted()` Returns value indicating whether or not this event was executed.

Field Detail

INTERVAL

public static final int INTERVAL

Timer(setInterval()) async event type code.

See Also:: getType(), IntervalAsyncEvent, Constant Field Values

TIMEOUT

public static final int TIMEOUT

Timer(setTimeout()) async event type code.

See Also:: getType(), TimeoutAsyncEvent, Constant Field Values

XMLHTTPREQUEST

public static final int XMLHTTPREQUEST

XmlHttpRequest async event type code.

See Also:: getType(), XmlHttpRequestAsyncEvent, Constant Field Values

METAREFRESH

public static final int METAREFRESH

Meta refresh async event type code.

See Also:: getType(), MetaRefreshAsyncEvent, Constant Field Values

Method Detail

getType

public int getType()

Returns async event type.

Returns:: one of the INTERVAL, TIMEOUT, XMLHTTPREQUEST or METAREFRESH values.

getTimeOffset

public long getTimeOffset()

Returns offset in milliseconds after which the event should be executed.

Returns:: offset in milliseconds after which the event should be executed.

isExecuted

public boolean isExecuted()

Returns value indicating whether or not this event was executed.

Returns:: value indicating whether or not this event was executed.

isCancelled

public boolean isCancelled()

Returns value indicating whether or not this event was cancelled.

Returns:: value indicating whether or not this event was cancelled.

getOriginatingNode

public org.w3c.dom.Node getOriginatingNode()

Returns originating node.

For MetaRefreshAsyncEvents this method returns corresponding meta element.
In case when async event creation is caused by execution of <script> block (for example: <script> setTimeout('alert(1)', 1000) </script>), this method returns script element node.
In case when async event creation is caused by execution of html element node's event handler (for example: <div onclick="setTimeout('alert(1)', 1000)"> ), this method returns corresponding html element node.
In case when async event creation is caused by execution of window event handler (for example: <body onload="setTimeout('alert(1)', 1000)"> (note that some of body event handlers, including onload are window event handlers)), this method returns document node.

Returns:: originating node.

getPage

public Page getPage()

Returns page which contains originating node returned by getOriginatingNode() method.

Returns:: page which contains originating node.