Packageflash.events
Classpublic class TimerEvent
InheritanceTimerEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions:  1.0, 9

Flash ® Player dispatches TimerEvent objects whenever a Timer object reaches the interval specified by the Timer.delay property.

View the examples

See also

flash.utils.Timer

Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
TimerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
Creates an Event object with specific information relevant to timer events.
TimerEvent
  
clone():Event
Creates a copy of the TimerEvent object and sets each property's value to match that of the original.
TimerEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in your custom Event class.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether preventDefault() has been called on the event.
Event
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
  
toString():String
Returns a string that contains all the properties of the TimerEvent object.
TimerEvent
  
updateAfterEvent():void
Instructs Flash Player to render after processing of this event completes, if the display list has been modified.
TimerEvent
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
 InheritedACTIVATE : String = "activate"
[static] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] Defines the value of the type property of an addedToStage event object.
Event
 InheritedCANCEL : String = "cancel"
[static] Defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] Defines the value of the type property of a change event object.
Event
 InheritedCLEAR : String = "clear"
[static] Defines the value of the type property of a clear event object.
Event
 InheritedCLOSE : String = "close"
[static] Defines the value of the type property of a close event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] Defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] Defines the value of the type property of a connect event object.
Event
 InheritedCOPY : String = "copy"
[static] Defines the value of the type property of a copy event object.
Event
 InheritedCUT : String = "cut"
[static] Defines the value of the type property of a cut event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame event object.
Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] Defines the value of the type property of an exitFrame event object.
Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] Defines the value of the type property of an frameConstructed event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] The Event.FULLSCREEN constant defines the value of the type property of a fullScreen event object.
Event
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] Defines the value of the type property of an init event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedOPEN : String = "open"
[static] Defines the value of the type property of an open event object.
Event
 InheritedPASTE : String = "paste"
[static] Defines the value of the type property of a paste event object.
Event
 InheritedREMOVED : String = "removed"
[static] Defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] Defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] Defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] Defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] Defines the value of the type property of a select event object.
Event
 InheritedSELECT_ALL : String = "selectAll"
[static] Defines the value of the type property of a selectAll event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
  TIMER : String = "timer"
[static] Defines the value of the type property of a timer event object.
TimerEvent
  TIMER_COMPLETE : String = "timerComplete"
[static] Defines the value of the type property of a timerComplete event object.
TimerEvent
 InheritedUNLOAD : String = "unload"
[static] Defines the value of the type property of an unload event object.
Event
Constructor Detail
TimerEvent()Constructor
public function TimerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Language Version: ActionScript 3.0
Runtime Versions:  1.0, 9

Creates an Event object with specific information relevant to timer events. Event objects are passed as parameters to event listeners.

Parameters
type:String — The type of the event. Event listeners can access this information through the inherited type property.
 
bubbles:Boolean (default = false) — Determines whether the Event object bubbles. Event listeners can access this information through the inherited bubbles property.
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property.
Method Detail
clone()method
override public function clone():Event

Language Version: ActionScript 3.0
Runtime Versions:  1.0, 9

Creates a copy of the TimerEvent object and sets each property's value to match that of the original.

Returns
Event — A new TimerEvent object with property values that match those of the original.
toString()method 
override public function toString():String

Language Version: ActionScript 3.0
Runtime Versions:  1.0, 9

Returns a string that contains all the properties of the TimerEvent object. The string is in the following format:

[TimerEvent type= value bubbles= value cancelable= value ]

Returns
String — A string that contains all the properties of the TimerEvent object.
updateAfterEvent()method 
public function updateAfterEvent():void

Language Version: ActionScript 3.0
Runtime Versions:  1.0, 9

Instructs Flash Player to render after processing of this event completes, if the display list has been modified.


Example

The following is an example for the TimerEvent.updateAfterEvent() method. 
function onTimer(event:TimerEvent):void {
    if (40 < my_mc.x && my_mc.x < 375) {
        my_mc.x-= 50;
    } else {
        my_mc.x=374;
    }
    event.updateAfterEvent();
}

var moveTimer:Timer=new Timer(50,250);
moveTimer.addEventListener(TimerEvent.TIMER,onTimer);
moveTimer.start();
Constant Detail
TIMERConstant
public static const TIMER:String = "timer"

Language Version: ActionScript 3.0
Runtime Versions:  1.0, 9

Defines the value of the type property of a timer event object.

This event has the following properties:

PropertyValue
bubbles false
cancelable false ; there is no default behavior to cancel.
currentTarget The object that is actively processing the Event object with an event listener.
target The Timer object that has reached its interval.

See also

flash.utils.Timer.timer
TIMER_COMPLETEConstant 
public static const TIMER_COMPLETE:String = "timerComplete"

Language Version: ActionScript 3.0
Runtime Versions:  1.0, 9

Defines the value of the type property of a timerComplete event object.

This event has the following properties:

PropertyValue
bubbles false
cancelable false ; there is no default behavior to cancel.
currentTarget The object that is actively processing the Event object with an event listener.
target The Timer object that has completed its requests.

See also

flash.utils.Timer.timerComplete
Examples How to use examples

The following example uses the TimerExample class to show how a listener method timerHandler() can be instantiated and set to listen for a new TimerEvent to be dispatched, which happens when the Timer's start() method is called. 
package {
    import flash.utils.Timer;
    import flash.events.TimerEvent;
    import flash.display.Sprite;

    public class TimerEventExample extends Sprite {

        public function TimerEventExample() {
            var myTimer:Timer = new Timer(1000, 2);
            myTimer.addEventListener(TimerEvent.TIMER, timerHandler);
            myTimer.start();
        }

        public function timerHandler(event:TimerEvent):void {
            trace("timerHandler: " + event);
        }
    }
}



Submit Feedback on LiveDocs
© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Sun Oct 19 2008, 07:03 PM -07:00