FlowNavigationEvent

Kind of class: public class
Package:
Inherits from:
  • Event
Dispatched by:
Classpath: org.asaplibrary.management.flow.FlowNavigationEvent
File last modified: Wednesday, 11 May 2011, 18:40:04
Event objects that are dispatched by FlowManager. Subscribe to type _EVENT.
Example
  • FlowManager.defaultFlowManager.addEventListener(FlowNavigationEvent._EVENT, handleNavigationEvent);

Summary

Constructor
  • FlowNavigationEvent (inSubtype:String, inName:String, inTrigger:Object = null, inDestination:String = null, inStoppingSections:Array = null, inStartingSections:Array = null)
    • Creates a new FlowNavigationEvent.
Constants
  • _EVENT : String
    • Event type.
  • WILL_UPDATE : String
    • Event subtype sent before changing state.
  • UPDATE : String
    • Event subtype sent after changing state.
  • FINISHED : String
    • Event subtype sent after changing state actions have been finished.
  • SECTIONS_STOPPING : String
    • Event subtype sent before sections are stopping.
  • SECTIONS_STARTING : String
    • Event subtype sent before sections are starting.
  • WILL_LOAD : String
    • Event subtype sent before trying to load a section movie.
  • LOADED : String
    • Event subtype sent after successfully loading a section movie.
  • LOADING_ERROR : String
    • Event subtype sent when an error occurred loading a section movie.
Instance properties
Instance methods
  • toString () : String
  • clone () : Event
    • Creates a copy of an existing FlowNavigationEvent.

Constructor

FlowNavigationEvent

function FlowNavigationEvent(inSubtype:String, inName:String, inTrigger:Object = null, inDestination:String = null, inStoppingSections:Array = null, inStartingSections:Array = null)

Creates a new FlowNavigationEvent. This event bubbles through and is cancelable.

Parameters
inSubtype :either subtype, see above
inName :name of the FlowSection
inTrigger :trigger of the navigation action
inDestination:(optional) name of destination FlowSection; when not specified this defaults to the FlowSection name

Constants

FINISHED

static const FINISHED:String = "finished"

Event subtype sent after changing state actions have been finished.

LOADED

static const LOADED:String = "loaded"

Event subtype sent after successfully loading a section movie.

LOADING_ERROR

static const LOADING_ERROR:String = "loadError"

Event subtype sent when an error occurred loading a section movie.

SECTIONS_STARTING

static const SECTIONS_STARTING:String = "sectionsStarting"

Event subtype sent before sections are starting.

SECTIONS_STOPPING

static const SECTIONS_STOPPING:String = "sectionsStopping"

Event subtype sent before sections are stopping.

UPDATE

static const UPDATE:String = "update"

Event subtype sent after changing state.

WILL_LOAD

static const WILL_LOAD:String = "willLoad"

Event subtype sent before trying to load a section movie.

WILL_UPDATE

static const WILL_UPDATE:String = "willUpdate"

Event subtype sent before changing state.

_EVENT

static const _EVENT:String = "navigationEvent"

Event type.

Instance properties

destination

destination:String(read,write)

name

name:String(read,write)

startingSections

startingSections:Array(read,write)

stoppingSections

stoppingSections:Array(read,write)

subtype

subtype:String(read,write)

trigger

trigger:Object(read,write)

The trigger of the FlowManager.goto action. This can be useful to differentiate navigation actions by button.

Instance methods

clone

override function clone() : Event

Creates a copy of an existing FlowNavigationEvent.

Overrides
  • Event.clone

toString

override function toString() : String
Overrides
  • Event.toString