+Show TOC
×Hide TOC

TweenEventType

Kind of class:	class
Inherits from:	EventType < String
Version:	1.0
Author:	Francis Bourre
Classpath:	com.bourre.transitions.TweenEventType
File last modified:	Wednesday, 31 October 2007, 07:35:30

► 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.
 */
 
/**
 * {@code TweenEventType} defines all available event's name in Tween API.
 * 
 * <p>Event "strong" type declaration is part of Pixlib Event API.
 * 
 * <p>Events broadcasted by {@link ITween} family classes.
 * <ul>
 *   <li>onStart</li>
 *   <li>onStop</li>
 *   <li>onMotionFinished</li>
 *   <li>onMotionChanged</li>
 * </ul>
 * 
 * <p>Example
 * <code>
 *   var e:TweenEvent = new TweenEvent( TweenEventType.onMotionFinished, this );
 * </code>
 * 
 * @author Francis Bourre
 * @version 1.0
 */
import com.bourre.events.EventType;

class com.bourre.transitions.TweenEventType extends EventType
{
    //-------------------------------------------------------------------------
    // Events definition
    //-------------------------------------------------------------------------
    
    /**
     * Broadcasted to listeners when tween starts.
     */
    [Event("onStart")]
    public static var onStartEVENT:TweenEventType = new TweenEventType("onStart");
    
    /**
     * Broadcasted to listeners when tween stops.
     */
    [Event("onStop")]
    public static var onStopEVENT:TweenEventType = new TweenEventType("onStop");
    
    /**
     * Broadcasted to listeners when tween is finished.
     */
    [Event("onMotionFinished")]
    public static var onMotionFinishedEVENT:TweenEventType = new TweenEventType("onMotionFinished");
    
    /**
     * Broadcasted to listeners when property value is updated.
     */
    [Event("onMotionChanged")]
    public static var onMotionChangedEVENT:TweenEventType = new TweenEventType("onMotionChanged");
    
    
    //-------------------------------------------------------------------------
    // Public API
    //-------------------------------------------------------------------------
    
    /**
     * Constructs a new {@code TweenEventType} instance
     * 
     * @param s Event name
     */
    public function TweenEventType(s:String)
    {
        super(s);
    }
}

TweenEventType defines all available event's name in Tween API.

Event "strong" type declaration is part of Pixlib Event API.

Events broadcasted by ITween family classes.

onStart
onStop
onMotionFinished
onMotionChanged

Example

var e:TweenEvent = new TweenEvent( TweenEventType.onMotionFinished, this );

Summary

Constructor

TweenEventType

Class properties

onStartEVENT
onStopEVENT
onMotionFinishedEVENT
onMotionChangedEVENT

Constructor

TweenEventType

function TweenEventType (

s:String)

Constructs a new TweenEventType instance

Parameters:

Event name

Class properties

onMotionChangedEVENT

static onMotionChangedEVENT:TweenEventType = new TweenEventType("onMotionChanged")

(read,write)

Broadcasted to listeners when property value is updated.

Component metadata:

Event	onMotionChanged

onMotionFinishedEVENT

static onMotionFinishedEVENT:TweenEventType = new TweenEventType("onMotionFinished")

(read,write)

Broadcasted to listeners when tween is finished.

Component metadata:

Event	onMotionFinished

onStartEVENT

static onStartEVENT:TweenEventType = new TweenEventType("onStart")

(read,write)

Broadcasted to listeners when tween starts.

Component metadata:

Event	onStart

onStopEVENT

static onStopEVENT:TweenEventType = new TweenEventType("onStop")

(read,write)

Broadcasted to listeners when tween stops.

Component metadata:

Event	onStop