+Show TOC
×Hide TOC

LoopEvent

Kind of class:	public class
Package:	com.bourre.events
Inherits from:	BasicEvent < Event
Author:	Cédric Néhémie
Classpath:	com.bourre.events.LoopEvent
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 listeners.
     * 
     * @author     C√©dric N√©h√©mie
     * @see        BasicEvent
     * @see        com.bourre.event.LoopCommand
     * @see        com.bourre.event.LoopCommandListener
     */
    public class LoopEvent extends BasicEvent 
    {
        private var _nCount : Number;
        
        /**
         * Creates a new <code>LoopEvent</code> object.
         * 
         * @param    type    name of the event type
         * @param    target    target object of this event
         * @param    count    the number of iterations realized
         *                     since this event be fired
         */
        public function LoopEvent ( type : String, target : Object = null, count : Number = 0 )
        {
            super( type, target );
            _nCount = count;
        }
        
        /**
         * Returns the iterations count since this event be fired.
         * 
         * @return    the number of iterations realized
         *             since this event be fired
         */
        public function getCount () : Number
        {
            return _nCount;
        }
        
        /**
         * Clone the event
         * 
         * @return    a clone of the event
         */
        override public function clone() : Event
        {
            return new LoopEvent(type, target, _nCount);
        }
    }
}

Event dispatched by the LoopCommand class
to its listeners.

Summary

Constructor

LoopEvent (type:String, target:Object = null, count:Number = 0)
- Creates a new LoopEvent object.

Instance properties

Instance properties inherited from BasicEvent

_oTarget _sType target type

Instance methods

getCount : Number
- Returns the iterations count since this event be fired.
clone : Event
- Clone the event

Instance methods inherited from BasicEvent

clone getTarget getType setTarget setType toString

Constructor

LoopEvent

public function LoopEvent (

type:String, target:Object = null, count:Number = 0)

Creates a new LoopEvent object.

Parameters:

type :

name of the event type

target:

target object of this event

count :

the number of iterations realized
since this event be fired

Instance methods

clone

override public function clone (

) : Event

Clone the event

Returns:

a clone of the event

Overrides:

BasicEvent.clone

getCount

public function getCount (

) : Number

Returns the iterations count since this event be fired.

Returns:

the number of iterations realized
since this event be fired