Packageorg.springextensions.actionscript.cairngorm
SVN browsingSequenceEvent.as
FisheyeSequenceEvent.as
Classpublic class SequenceEvent



Documentation reference: event sequences


Public Properties
 PropertyDefined by
  dispatcher : IEventDispatcher
[read-only]
SequenceEvent
  eventClass : Class
[read-only]
SequenceEvent
  nextEventTriggers : Array
[read-only]
SequenceEvent
  parameters : Array
[read-only]
SequenceEvent
Public Methods
 MethodDefined by
  
SequenceEvent(eventClass:Class, parameters:Array = null, nextEventTriggers:Array = null, dispatcher:IEventDispatcher = null)
Creates a new SequenceEvent instance.
SequenceEvent
  
createEvent():Event
SequenceEvent
  
dispatch(event:Event):Boolean
Dispatches the argument event.
SequenceEvent
  
withDispatcher(dispatcher:IEventDispatcher, eventClass:Class, parameters:Array = null, nextEventTriggers:Array = null):SequenceEvent
[static]
SequenceEvent
Property detail
dispatcherproperty
dispatcher:IEventDispatcher  [read-only]Implementation
    public function get dispatcher():IEventDispatcher
eventClassproperty 
eventClass:Class  [read-only]Implementation
    public function get eventClass():Class
nextEventTriggersproperty 
nextEventTriggers:Array  [read-only]Implementation
    public function get nextEventTriggers():Array
parametersproperty 
parameters:Array  [read-only]Implementation
    public function get parameters():Array
Constructor detail
SequenceEvent()constructor
public function SequenceEvent(eventClass:Class, parameters:Array = null, nextEventTriggers:Array = null, dispatcher:IEventDispatcher = null)

Creates a new SequenceEvent instance.

Parameters
eventClass:Class
 
parameters:Array (default = null)
 
nextEventTriggers:Array (default = null)
 
dispatcher:IEventDispatcher (default = null)
Method detail
createEvent()method
public function createEvent():Event

Returns
Event
dispatch()method 
public function dispatch(event:Event):Boolean

Dispatches the argument event. If there is a dispatcher, the dispatcher is used. Otherwise, if the event is a CairngormEvent, it is dispatched using the event's dispatch method. Otherwise, nothing happens and the result is false.

Parameters
event:Event — event

Returns
Boolean — was the event dispatched successfully?
withDispatcher()method 
public static function withDispatcher(dispatcher:IEventDispatcher, eventClass:Class, parameters:Array = null, nextEventTriggers:Array = null):SequenceEventParameters
dispatcher:IEventDispatcher
 
eventClass:Class
 
parameters:Array (default = null)
 
nextEventTriggers:Array (default = null)

Returns
SequenceEvent