| Package | impression.events |
| Class | public class CueEvent |
| Inheritance | CueEvent  StoryboardEvent flash.events.Event |
| Property | Defined By | ||
|---|---|---|---|
| childElement : ChildElement [read-only]
The ChildElement associated with the event. | CueEvent | ||
| complete : Boolean
Indicates whether or not the childElement parameter's complete persisted property
should be set to true when the event returns. | CueEvent | ||
| currentPosition : Number [read-only]
The value of the position property of the ChildElement object that triggered the event. | CueEvent | ||
 | sb : Storyboard [read-only]
The Storyboard object assigned to the target. | StoryboardEvent | |
| Method | Defined By | ||
|---|---|---|---|
CueEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, sb:Storyboard = null, currentPosition:Number = -1, childElement:ChildElement = null, complete:Boolean = true)
Creates a new instance of a CueEvent object. | CueEvent | ||
clone():Event [override]
Duplicates an instance of the event object. | CueEvent | ||
toString():String [override]
Returns a string containing all the properties of the CueEvent object. | CueEvent | ||
| Constant | Defined By | ||
|---|---|---|---|
| COMPLETE : String = complete [static]
The StoryboardEvent.COMPLETE constant defines the value of the
type property of a complete event object. | StoryboardEvent | |
| CONTENT_LOAD_BEGIN : String = contentLoadBegin [static]
The StoryboardEvent.CONTENT_LOAD_BEGIN constant defines the value of the
type property of a content load begin event object. | StoryboardEvent | |
| CONTENT_LOAD_END : String = contentLoadEnd [static]
The StoryboardEvent.CONTENT_LOAD_END constant defines the value of the
type property of a content load end event object. | StoryboardEvent | |
| CUE : String = cue [static]
The CueEvent.CUE constant defines the value of the type property of an cue event object. | CueEvent | ||
| INITIALIZE : String = initialize [static]
The StoryboardEvent.INITIALIZE constant defines the value of the
type property of a initialize event object. | StoryboardEvent | |
| LOAD_COMPLETE : String = loadComplete [static]
The StoryboardEvent.LOAD_COMPLETE constant defines the value of the
type property of a load event object. | StoryboardEvent | |
| LOAD_START : String = loadStart [static]
The StoryboardEvent.LOAD_START constant defines the value of the
type property of an load start event object. | StoryboardEvent | |
| UNLOAD : String = unload [static]
The StoryboardEvent.UNLOAD constant defines the value of the
type property of an unload event object. | StoryboardEvent | |
| childElement | property |
Hide Inherited Public Properties
Show Inherited Public PropertieschildElement:ChildElement [read-only] The ChildElement associated with the event.
public function get childElement():ChildElement| complete | property |
complete:Boolean
Indicates whether or not the childElement parameter's complete persisted property
should be set to true when the event returns.
All players that dispatch the CueEvent event object store the value of this property as the ChildElement
object's complete persisted property when execution returns to the player. Always use the event's complete
property value instead of the ChildElement object's complete persisted property.
public function get complete():Boolean public function set complete(value:Boolean):void| currentPosition | property |
currentPosition:Number [read-only]
The value of the position property of the ChildElement object that triggered the event.
public function get currentPosition():Number| CueEvent | () | Constructor |
public function CueEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, sb:Storyboard = null, currentPosition:Number = -1, childElement:ChildElement = null, complete:Boolean = true)Creates a new instance of a CueEvent object.
Parameterstype:String — The type of the event. Event listeners can access this information through the inherited type property.
| |
bubbles:Boolean (default = false)bubbles property.
| |
cancelable:Boolean (default = false)cancelable property.
| |
sb:Storyboard (default = null)sb property.
| |
currentPosition:Number (default = -1)position property of the ChildElement object that triggered the event. Event listeners can access this information through the currentPosition property.
| |
childElement:ChildElement (default = null)childElement property.
| |
complete:Boolean (default = true)childElement parameter's complete persisted property should be set to true when the event returns. Event listeners can access this information through the complete property.
|
| clone | () | method |
override public function clone():EventDuplicates an instance of the event object.
Returns a new CueEvent object that is a copy of the original instance of the CueEvent object.
You do not normally call clone(); the EventDispatcher class calls it automatically when you redispatch
an event--that is, when you call dispatchEvent(event) from a handler that is handling event.
Event — A new CueEvent object that is identical to the original.
|
| toString | () | method |
override public function toString():StringReturns a string containing all the properties of the CueEvent object. The string is in the following format:
[CueEvent type=value bubbles=value cancelable=value eventPhase=value sb=value currentPosition=value childElement=value complete=value]
String — A string containing all the properties of the CueEvent object.
|
| CUE | Constant |
public static const CUE:String = cueThe CueEvent.CUE constant defines the value of the type property of an cue 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 object that raised the event. |
| sb | The Storyboard object assigned to the target. |
| currentPosition | The value of the position property of the ChildElement object that triggered the event. |
| childElement | The ChildElement object that triggered the event. |
| complete | Indicates whether or not the childElement parameter's complete
persisted property should be set to true when the event returns. |