Package | org.fluint.sequence |
Class | public class SequenceWaiter |
Inheritance | SequenceWaiter ![]() |
Implements | ISequencePend |
Subclasses | SequenceDelay |
Property | Defined By | ||
---|---|---|---|
eventName : String [read-only]
Name of the event that will be broadcast by the target. | SequenceWaiter | ||
target : IEventDispatcher [read-only]
The event dispatcher where the properties/value pairs defined
in the props object will be set. | SequenceWaiter | ||
timeout : int [read-only]
The number of milliseconds this class should wait for its handleEvent
method to be called, before firing a 'timerExpired' event. | SequenceWaiter | ||
timeoutHandler : Function [read-only]
A reference to the event handler that should be called if the event named in eventName
does not fire before the timeout is reached. | SequenceWaiter |
Method | Defined By | ||
---|---|---|---|
SequenceWaiter(target:IEventDispatcher, eventName:String, timeout:int, timeoutHandler:Function = null)
Constructor. | SequenceWaiter | ||
setupListeners(testCase:*, sequence:SequenceRunner):void
Called by the SequenceRunner to cause the setup of event listeners
| SequenceWaiter |
eventName | property |
eventName:String
[read-only] Name of the event that will be broadcast by the target. When this event is broadcast, the TestCase sequence code moves onto the next step in the sequence.
public function get eventName():String
target | property |
target:IEventDispatcher
[read-only] The event dispatcher where the properties/value pairs defined in the props object will be set.
public function get target():IEventDispatcher
timeout | property |
timeout:int
[read-only] The number of milliseconds this class should wait for its handleEvent method to be called, before firing a 'timerExpired' event.
public function get timeout():int
timeoutHandler | property |
timeoutHandler:Function
[read-only] A reference to the event handler that should be called if the event named in eventName does not fire before the timeout is reached. The handler is expected to have the follow signature: public function handleTimeoutEvent( passThroughData:Object ):void { } The parameter is a generic object that can optionally be provided by the developer when starting a new asynchronous operation.
public function get timeoutHandler():Function
SequenceWaiter | () | Constructor |
public function SequenceWaiter(target:IEventDispatcher, eventName:String, timeout:int, timeoutHandler:Function = null)
Constructor.
Parameterstarget:IEventDispatcher — The target where properties will be set.
| |
eventName:String — Event broadcast after the properties are set.
| |
timeout:int — The number of milliseconds to wait before calling the timoutHandler.
| |
timeoutHandler:Function (default = null ) — Called if the timout is reached before the event is broadcast.
|
setupListeners | () | method |
public function setupListeners(testCase:*, sequence:SequenceRunner):void
Called by the SequenceRunner to cause the setup of event listeners
Parameters
testCase:* | |
sequence:SequenceRunner |