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

Package | org.fluint.sequence
Class | public class SequenceCaller
Inheritance | SequenceCaller Object
Implements | ISequenceAction

A sequence step that calls a method

Public Properties

| Property | Defined By
--- | --- | ---
|  | args : Array [read-only] An array that contains the arguments to the method that will be called | SequenceCaller
|  | argsFunction : Function [read-only] Function that returns an array of arguments to be passed to the method. | SequenceCaller
|  | method : Function [read-only] A method to be executed when this step occurs | SequenceCaller
|  | target : IEventDispatcher [read-only] The event dispatcher where the properties/value pairs defined in the props object will be set. | SequenceCaller

Public Methods

| Method | Defined By
--- | --- | ---
|  | SequenceCaller(target:IEventDispatcher, method:Function, args:Array = null, argsFunction:Function = null) Constructor. | SequenceCaller
|  | execute():void Sets the name/value pairs defined in the props object to the target. | SequenceCaller

Property Detail

args | property

`args:Array` [read-only]

An array that contains the arguments to the method that will be called

Implementation
`public function get args():Array`

argsFunction | property |

`argsFunction:Function` [read-only]

Function that returns an array of arguments to be passed to the method. When using the args array, each item is evaluated at the time when the step is created. Using the argsFunction, the function is called just before method invocation, providing a set of arguments that are evaluated during step execution.

Implementation
`public function get argsFunction():Function`

method | property |

`method:Function` [read-only]

A method to be executed when this step occurs

Implementation
`public function get method():Function`

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`
Constructor Detail

SequenceCaller | () | Constructor

`public function SequenceCaller(target:IEventDispatcher, method:Function, args:Array = null, argsFunction:Function = null)`

Constructor.

Parameters

| `target:IEventDispatcher` — The target object containing method
| `method:Function` — Method that will be executed when this step is executed.
| `args:Array` (default = `null`)`` — Optional parameter that contains an array of arguments that will be passed to this method.
| `argsFunction:Function` (default = `null`)`` — Optional function that returns an of arguments to be passed to method.

Method Detail

execute | () | method

`public function execute():void`

Sets the name/value pairs defined in the props object to the target.

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