+Show TOC
×Hide TOC

SequenceEvent

Kind of class:	public class
Package:	org.casalib.events
Inherits from:	Event
Dispatched by:	Sequence
Version:	10/27/08
Author:	Jon Adams, Aaron Clinger
Classpath:	org.casalib.events.SequenceEvent
File last modified:	Monday, 01 December 2008, 11:56:32

► View source

▼ Hide source

package org.casalib.events {
    import flash.events.Event;
    
    
    /**
        An event dispatched from {@link Sequence}.
        
        @author Jon Adams
        @author Aaron Clinger
        @version 10/27/08
    */
    public class SequenceEvent extends Event {
        public static const COMPLETE:String = 'complete';
        public static const RESUME:String   = 'resume';
        public static const START:String    = 'start';
        public static const STOP:String     = 'stop';
        public static const LOOP:String     = 'loop';
        protected var _loops:uint;
        
        
        /**
            Creates a new SequenceEvent.
            
            @param type: The type of event.
            @param bubbles: Determines whether the Event object participates in the bubbling stage of the event flow.
            @param cancelable: Determines whether the Event object can be canceled.
        */
        public function SequenceEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false) {
            super(type, bubbles, cancelable);
        }
        
        /**
            The number of times the sequence has run.
        */
        public function get loops():uint {
            return this._loops;
        }
        
        public function set loops(loops:uint):void {
            this._loops = loops;
        }
        
        /**
            @return A string containing all the properties of the event.
        */
        override public function toString():String {
            return formatToString('SequenceEvent', 'type', 'bubbles', 'cancelable', 'loops');
        }
        
        /**
            @return Duplicates an instance of the event.
        */
        override public function clone():Event {
            var e:SequenceEvent = new SequenceEvent(this.type, this.bubbles, this.cancelable);
            e.loops = this.loops;
            
            return e;
        }
    }
}

An event dispatched from Sequence.

Summary

Constructor

SequenceEvent (type:String, bubbles:Boolean = false, cancelable:Boolean = false)
- Creates a new SequenceEvent.

Constants

COMPLETE : String
RESUME : String
START : String
STOP : String
LOOP : String

Instance properties

loops : uint
- The number of times the sequence has run.

Instance methods

toString : String
clone : Event

Constructor

SequenceEvent

public function SequenceEvent (

type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Creates a new SequenceEvent.

Parameters:

type :

The type of event.

bubbles :

Determines whether the Event object participates in the bubbling stage of the event flow.

cancelable:

Determines whether the Event object can be canceled.

Constants

COMPLETE

public static const COMPLETE:String = 'complete'

(read)

LOOP

public static const LOOP:String = 'loop'

(read)

RESUME

public static const RESUME:String = 'resume'

(read)

START

public static const START:String = 'start'

(read)

STOP

public static const STOP:String = 'stop'

(read)

Instance properties

loops

public loops:uint

(read,write)

The number of times the sequence has run.

Instance methods

clone

override public function clone (

) : Event

Returns:

Duplicates an instance of the event.

Overrides:

Event.clone

toString

override public function toString (

) : String

Returns:

A string containing all the properties of the event.

Overrides:

Event.toString