TimerEvent

(Beta)

Package	flash.events
Class	public class TimerEvent
Inheritance	TimerEvent Event Object

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Lite 4

A Timer object dispatches a TimerEvent objects whenever the Timer object reaches the interval specified by the Timer.delay property.

View the examples

Related API Elements

flash.utils.Timer

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		TimerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false) Creates an Event object with specific information relevant to timer events.	TimerEvent
		clone():Event [override] Creates a copy of the TimerEvent object and sets each property's value to match that of the original.	TimerEvent
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		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
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a string that contains all the properties of the TimerEvent object.	TimerEvent
		updateAfterEvent():void Instructs Flash Player or the AIR runtime to render after processing of this event completes, if the display list has been modified.	TimerEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		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

Constructor Detail

()

Constructor

public function TimerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Lite 4

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:

AIR 1.0, Flash Player 9, Flash Lite 4

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:

AIR 1.0, Flash Player 9, Flash Lite 4

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:

AIR 1.0, Flash Player 9, Flash Lite 4

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

Example ( How to use this example )

The following is an example for the TimerEvent.updateAfterEvent() method.

Copy

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

TIMER

Constant

public static const TIMER:String = "timer"

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Lite 4

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

This event has the following properties:

Property	Value
`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.

Related API Elements

flash.utils.Timer.timer

TIMER_COMPLETE

Constant

public static const TIMER_COMPLETE:String = "timerComplete"

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Lite 4

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

This event has the following properties:

Property	Value
`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.

Related API Elements

flash.utils.Timer.timerComplete

Examples How to use this example

TimerEventExample.as

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.

Copy

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);
        }
    }
}

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

TimerEvent - AS3

Classes x

TimerEvent

clone

toString

updateAfterEvent

TIMER

TIMER_COMPLETE