ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
org.osmf.events 

TimeEvent  - AS3 OSMF FLEXOSMF

Packageorg.osmf.events
Classpublic class TimeEvent
InheritanceTimeEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Versions: OSMF 1.0, OSMF for Flex 4.0
Runtime Versions: Flash Player 10, AIR 1.5

A TimeEvent is dispatched when properties of a TimeTrait change.



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
 Inheritedtarget : Object
[read-only] The event target.
Event
  time : Number
[read-only] New time value resulting from this change.
TimeEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
TimeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, time:Number = NaN)
Constructor
TimeEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  COMPLETE : String = "complete"
[static] The TimeEvent.COMPLETE constant defines the value of the type property of the event object for a complete event.
TimeEvent
  CURRENT_TIME_CHANGE : String = "currentTimeChange"
[static] The TimeEvent.CURRENT_TIME_CHANGE constant defines the value of the type property of the event object for a currentTimeChange event.
TimeEvent
  DURATION_CHANGE : String = "durationChange"
[static] The TimeEvent.DURATION_CHANGE constant defines the value of the type property of the event object for a durationChange event.
TimeEvent
Property Detail

time

property
time:Number  [read-only]

Language Version: ActionScript 3.0
Product Versions: OSMF 1.0, OSMF for Flex 4.0
Runtime Versions: Flash Player 10, AIR 1.5

New time value resulting from this change. For currentTimeChange events, this corresponds to the currentTime property. For durationChange events, this corresponds to the duration property. For complete events, this is unused.



Implementation
    public function get time():Number
Constructor Detail

TimeEvent

()Constructor
public function TimeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, time:Number = NaN)

Language Version: ActionScript 3.0
Product Versions: OSMF 1.0, OSMF for Flex 4.0
Runtime Versions: Flash Player 10, AIR 1.5

Constructor

Parameters
type:String — The type of the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
time:Number (default = NaN) — The new time for the event. The property to which this value applies depends on the event type constant.
Constant Detail

COMPLETE

Constant
public static const COMPLETE:String = "complete"

Language Version: ActionScript 3.0
Product Versions: OSMF 1.0, OSMF for Flex 4.0
Runtime Versions: Flash Player 10, AIR 1.5

The TimeEvent.COMPLETE constant defines the value of the type property of the event object for a complete event.

CURRENT_TIME_CHANGE

Constant 
public static const CURRENT_TIME_CHANGE:String = "currentTimeChange"

Language Version: ActionScript 3.0
Product Versions: OSMF 1.0, OSMF for Flex 4.0
Runtime Versions: Flash Player 10, AIR 1.5

The TimeEvent.CURRENT_TIME_CHANGE constant defines the value of the type property of the event object for a currentTimeChange event.

DURATION_CHANGE

Constant 
public static const DURATION_CHANGE:String = "durationChange"

Language Version: ActionScript 3.0
Product Versions: OSMF 1.0, OSMF for Flex 4.0
Runtime Versions: Flash Player 10, AIR 1.5

The TimeEvent.DURATION_CHANGE constant defines the value of the type property of the event object for a durationChange event.