API Documentation | All Packages | All Classes | Index | Frames No Frames |
SequenceWaiter

Package | org.fluint.sequence
Class | public class SequenceWaiter
Inheritance | SequenceWaiter Object
Implements | ISequencePend
Subclasses | SequenceDelay

The sequence setter class tells the TestCase instance to pend until the eventName occurs or the timeout expires.

Public Properties

| 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

Public Methods

| 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

Property Detail

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.

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

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

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

Implementation
`public function get timeoutHandler():Function`
Constructor Detail

SequenceWaiter | () | Constructor

`public function SequenceWaiter(target:IEventDispatcher, eventName:String, timeout:int, timeoutHandler:Function = null)`

Constructor.

Parameters

| `target: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.

Method Detail

setupListeners | () | method

`public function setupListeners(testCase:*, sequence:SequenceRunner):void`

Called by the SequenceRunner to cause the setup of event listeners

Parameters

| `testCase:*`
| `sequence:SequenceRunner`

Thu Apr 10 2014, 08:07 AM +10:00