Packagepotomac.core
Classpublic class StartupEvent
InheritanceStartupEvent Inheritance flash.events.Event

StartupEvents are associated with Potomac's startup process. These events are associated with [StartupListener]s or IPotomacPreloaders.



Public Methods
 MethodDefined By
  
StartupEvent(type:String)
Constructs a StartupEvent of the given type.
StartupEvent
Public Constants
 ConstantDefined By
  LAUNCHRUNNER_COMPLETE : String = launchRunnerComplete
[static] The StartupEvent.LAUNCHRUNNER_COMPLETE constant defines the value of the type property of the event object for a launchRunnerComplete event.
StartupEvent
  POTOMAC_INITIALIZED : String = potomacInitialized
[static] The StartupEvent.POTOMAC_INITIALIZED constant defines the value of the type property of the event object for a potomacInitialized event.
StartupEvent
  PRELOADER_CLOSE_COMPLETE : String = preloaderCloseComplete
[static] The StartupEvent.PRELOADER_CLOSE_COMPLETE constant defines the value of the type property of the event object for a preloaderCloseComplete event.
StartupEvent
  PRELOADER_CLOSE_START : String = preloaderCloseStart
[static] The StartupEvent.PRELOADER_CLOSE_START constant defines the value of the type property of the event object for a preloaderCloseStart event.
StartupEvent
  STARTUPLISTENER_COMPLETE : String = potomacStartupListenerComplete
[static] The StartupEvent.STARTUPLISTENER_COMPLETE constant defines the value of the type property of the event object for a potomacStartupListenerComplete event.
StartupEvent
Constructor Detail
StartupEvent()Constructor
public function StartupEvent(type:String)

Constructs a StartupEvent of the given type.

Parameters
type:String
Constant Detail
LAUNCHRUNNER_COMPLETEConstant
public static const LAUNCHRUNNER_COMPLETE:String = launchRunnerComplete

The StartupEvent.LAUNCHRUNNER_COMPLETE constant defines the value of the type property of the event object for a launchRunnerComplete event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.

POTOMAC_INITIALIZEDConstant 
public static const POTOMAC_INITIALIZED:String = potomacInitialized

The StartupEvent.POTOMAC_INITIALIZED constant defines the value of the type property of the event object for a potomacInitialized event. This event is dispatched to [StartupListener]s to allow them a hook after the initial bundles have been loaded but before the application's template has been created. Startup listeners are typically used to show a login dialog and/or to allow for loading additional bundles dynamically.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.

PRELOADER_CLOSE_COMPLETEConstant 
public static const PRELOADER_CLOSE_COMPLETE:String = preloaderCloseComplete

The StartupEvent.PRELOADER_CLOSE_COMPLETE constant defines the value of the type property of the event object for a preloaderCloseComplete event. This event is dispatched by an IPotomacPreloader (after it has received a PRELOADER_CLOSE_START) to notify the Potomac core code that it is ready to be closed. This event is typically dispatched after an animation has been executed on the preloader.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.

PRELOADER_CLOSE_STARTConstant 
public static const PRELOADER_CLOSE_START:String = preloaderCloseStart

The StartupEvent.PRELOADER_CLOSE_START constant defines the value of the type property of the event object for a preloaderCloseStart event. This event is dispatched on IPotomacPrealoder's to notify them that they may begin closing themselves. Typically this means running some sort of animation. The preloader is expected to dispatch PRELOADER_CLOSE_COMPLETE when the animation is complete and the preloader may be closed.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.

STARTUPLISTENER_COMPLETEConstant 
public static const STARTUPLISTENER_COMPLETE:String = potomacStartupListenerComplete

The StartupEvent.STARTUPLISTENER_COMPLETE constant defines the value of the type property of the event object for a potomacStartupListenerComplete event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.