+Show TOC
×Hide TOC

IterationEvent

Kind of class:	public class
Package:	com.bourre.events
Inherits from:	BasicEvent < Event
Author:	Cédric Néhémie
Classpath:	com.bourre.events.IterationEvent
File last modified:	Monday, 24 November 2008, 11:36:53

► View source

▼ Hide source

/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.mozilla.org/MPL/MPL-1.1.html
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.bourre.events 
{
    import com.bourre.events.BasicEvent;
    
    import flash.events.Event;        

    /**
     * Event dispatched by the <code>LoopCommand</code> class
     * to its dedicated <code>IterationCommand</code>. The event
     * carry the iteration index, and its associated value, provided
     * by the <code>Iterator</code> used by the loop command.
     * 
     * @author     C√©dric N√©h√©mie
     * @see        BasicEvent
     * @see        com.bourre.event.LoopCommand
     * @see        com.bourre.event.IterationCommand
     */
    public class IterationEvent extends BasicEvent 
    {
        private var _nIndex : Number;
        private var _oValue : *;
        
        /**
         * Creates a new <code>Iteration</code> event.
         * 
         * @param    type    name of this event type
         * @param    target    target of this event
         * @param    index    index of the current iteration
         * @param    value    value associated with this iteration
         */
        public function IterationEvent ( type : String, target : Object = null, index : Number = 0, value : * = null )
        {
            super( type, target );
            
            _nIndex = index;
            _oValue = value;
        }
        
        /**
         * Returns the index of the iteration in the loop
         * performed by the <code>LoopCommand</code>.
         * 
         * @return    the index of the iteration in the loop
         *             performed by the <code>LoopCommand</code>
         */
        public function getIndex () : Number
        {
            return _nIndex;
        }        
        /**
         * Returns the value of the iteration in the loop
         * performed by the <code>LoopCommand</code>.
         * 
         * @return    the value of the iteration in the loop
         *             performed by the <code>LoopCommand</code>
         */
        public function getValue () : *
        {
            return _oValue;
        }
        
        /**
         * Clone the event
         * 
         * @return    a clone of the event
         */
        override public function clone() : Event
        {
            return new IterationEvent(type, target, _nIndex, _oValue);
        }
    }
}

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.

Summary

Constructor

IterationEvent (type:String, target:Object = null, index:Number = 0, value:* = null)
- Creates a new Iteration event.

Instance properties

Instance properties inherited from BasicEvent

_oTarget _sType target type

Instance methods

getIndex : Number
- Returns the index of the iteration in the loop
getValue : *
- Returns the value of the iteration in the loop
clone : Event
- Clone the event

Instance methods inherited from BasicEvent

clone getTarget getType setTarget setType toString

Constructor

IterationEvent

public function IterationEvent (

type:String, target:Object = null, index:Number = 0, value:* = null)

Creates a new Iteration event.

Parameters:

type :

name of this event type

target:

target of this event

index :

index of the current iteration

value :

value associated with this iteration

Instance methods

clone

override public function clone (

) : Event

Clone the event

Returns:

a clone of the event

Overrides:

BasicEvent.clone

getIndex

public function getIndex (

) : Number

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

Returns:

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

getValue

public function getValue (

) : *

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