Packagecom.bourre.events
Classpublic class IterationEvent
InheritanceIterationEvent Inheritance BasicEvent Inheritance flash.events.Event

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Event dispatched by the LoopCommand class to its dedicated IterationCommand. The event carry the iteration index, and its associated value, provided by the Iterator used by the loop command.

See also

BasicEvent.html


Public Properties
 PropertyDefined by
 Inheritedtarget : Object
The source object of this event
BasicEvent
 Inheritedtype : String
The type of this event
BasicEvent
Protected Properties
 PropertyDefined by
 Inherited_oTarget : Object
The source object of this event, redefined to provide write access
BasicEvent
 Inherited_sType : String
The type of the event, redefined to provide write access
BasicEvent
Public Methods
 MethodDefined by
  
IterationEvent(type:String, target:Object = null, index:Number = 0, value:* = null)
Creates a new Iteration event.
IterationEvent
  
clone():Event
Clone the event
IterationEvent
  
getIndex():Number
Returns the index of the iteration in the loop performed by the LoopCommand.
IterationEvent
 Inherited
getTarget():Object
Returns the current source of this event object.
BasicEvent
 Inherited
getType():String
Returns the type of this event, which generally correspond to the name of the called function on the listener.
BasicEvent
  
Returns the value of the iteration in the loop performed by the LoopCommand.
IterationEvent
 Inherited
setTarget(oTarget:Object):void
Defines the new source object of this event.
BasicEvent
 Inherited
setType(en:String):void
Defines the new event type for this event object.
BasicEvent
 Inherited
toString():String
Returns the string representation of this instance.
BasicEvent
Constructor detail
IterationEvent()constructor
public function IterationEvent(type:String, target:Object = null, index:Number = 0, value:* = null)

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Creates a new Iteration event.

Parameters
type:String — name of this event type
 
target:Object (default = null) — target of this event
 
index:Number (default = 0) — index of the current iteration
 
value:* (default = null) — value associated with this iteration
Method detail
clone()method
public override function clone():Event

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Clone the event

Returns
Event — a clone of the event
getIndex()method 
public function getIndex():Number

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the index of the iteration in the loop performed by the LoopCommand.

Returns
Number — the index of the iteration in the loop performed by the LoopCommand
getValue()method 
public function getValue():*

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the value of the iteration in the loop performed by the LoopCommand.

Returns
* — the value of the iteration in the loop performed by the LoopCommand