Packagecom.bourre.commands
Classpublic class AbstractIterationCommand
ImplementsIterationCommand

Player version: Flash Player 9.0
Language version: ActionScript 3.0

AbstractIterationCommand provides a skeleton for concret IterationCommand implementations.

IterationCommands are not fully stateless as they provide to the LoopCommand which own them the iterator onto which they will work.

For informations and examples on the behavior of loop commands see the How to use LoopCommand and IterationCommand document.



Protected Properties
 PropertyDefined by
  _oIterator : Iterator
A reference to the iterator used by this command
AbstractIterationCommand
Public Methods
 MethodDefined by
  
Initializes this iteration command with the passed-in Iterator.
AbstractIterationCommand
  
execute(e:Event = null):void
Override the execute virtual method to create a concret iteration command.
AbstractIterationCommand
  
Returns the iterator composed by this command.
AbstractIterationCommand
  
Defines which iterator is composed by this command
AbstractIterationCommand
  
toString():String
Returns the string representation of this object.
AbstractIterationCommand
Property detail
_oIteratorproperty
protected var _oIterator:Iterator

Player version: Flash Player 9.0
Language version: ActionScript 3.0

A reference to the iterator used by this command

Constructor detail
AbstractIterationCommand()constructor
public function AbstractIterationCommand(i:Iterator)

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Initializes this iteration command with the passed-in Iterator.

Parameters
i:Iterator
Method detail
execute()method
public function execute(e:Event = null):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Override the execute virtual method to create a concret iteration command. Concret command may use the passed-in event as data source for their operation. Used with a LoopCommand the passed-in event is an IterationEvent.

Parameters
e:Event (default = null) — event object that will be used as data source by the command

Throws
UnimplementedVirtualMethodException — Concret command doesn't override the execute method
iterator()method 
public function iterator():Iterator

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the iterator composed by this command.

Returns
Iterator — the iterator composed by this command
setIterator()method 
public function setIterator(i:Iterator):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Defines which iterator is composed by this command

Parameters
i:Iterator — iterator instance to be used by this command
toString()method 
public function toString():String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the string representation of this object.

Returns
String — the string representation of this object