| Package | impression.events |
| Class | public class CheckForCompleteEvent |
| Inheritance | CheckForCompleteEvent  StoryboardEvent flash.events.Event |
| Property | Defined By | ||
|---|---|---|---|
| completeRemaining : String
The completion criteria not yet met by the storyboard. | CheckForCompleteEvent | ||
| completeWhen : String [read-only]
The completion criteria required for the storyboard. | CheckForCompleteEvent | ||
 | sb : Storyboard [read-only]
The Storyboard object assigned to the target. | StoryboardEvent | |
| Method | Defined By | ||
|---|---|---|---|
CheckForCompleteEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, sb:Storyboard = null, completeWhen:String = null, completeRemaining:String = null)
Creates a new instance of a CheckForCompleteEvent object. | CheckForCompleteEvent | ||
clone():Event [override]
Duplicates an instance of the event object. | CheckForCompleteEvent | ||
toString():String [override]
Returns a string containing all the properties of the CheckForCompleteEvent object. | CheckForCompleteEvent | ||
| Constant | Defined By | ||
|---|---|---|---|
| CHECK_FOR_COMPLETE : String = checkForComplete [static]
The CheckForCompleteEvent.CHECK_FOR_COMPLETE constant defines the value of the
type property of a check for complete event object. | CheckForCompleteEvent | ||
| 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 | |
| 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 | |
| completeRemaining | property |
Hide Inherited Public Properties
Show Inherited Public PropertiescompleteRemaining:StringThe completion criteria not yet met by the storyboard.
All players that dispatch the CheckForCompleteEvent event object store the value of this property as the Storyboard
object's completeRemaining persisted property when execution returns to the player. Always use the event's completeRemaining
property value instead of the Storyboard object's completeRemaining persisted property.
public function get completeRemaining():String public function set completeRemaining(value:String):void| completeWhen | property |
completeWhen:String [read-only] The completion criteria required for the storyboard.
public function get completeWhen():String| CheckForCompleteEvent | () | Constructor |
public function CheckForCompleteEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, sb:Storyboard = null, completeWhen:String = null, completeRemaining:String = null)Creates a new instance of a CheckForCompleteEvent 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.
| |
completeWhen:String (default = null)completeWhen property.
| |
completeRemaining:String (default = null)completeRemaining property.
|
| clone | () | method |
override public function clone():EventDuplicates an instance of the event object.
Returns a new CheckForCompleteEvent object that is a copy of the original instance of the CheckForCompleteEvent 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 CheckForCompleteEvent object that is identical to the original.
|
| toString | () | method |
override public function toString():StringReturns a string containing all the properties of the CheckForCompleteEvent object. The string is in the following format:
[CheckForCompleteEvent type=value bubbles=value cancelable=value eventPhase=value sb=value completeWhen=value completeRemaining=value]
String — A string containing all the properties of the CheckForCompleteEvent object.
|
| CHECK_FOR_COMPLETE | Constant |
public static const CHECK_FOR_COMPLETE:String = checkForCompleteThe CheckForCompleteEvent.CHECK_FOR_COMPLETE constant defines the value of the type property of a check for complete 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. |
| completeWhen | The completion criteria required for the storyboard. |
| completeRemaining | The completion criteria not yet met by the storyboard. |