Packagesoi.events
Classpublic class ProjectEvent
InheritanceProjectEvent Inheritance flash.events.Event

The ProjectEvent class represents event objects that are dispatched to navigate, save, load, open and close the active project and its files. The majority of events dispatched by this class are listened to and processed in the Application class. The events are dispatched by the Application class as well as classes of composite components in the screen, section and core packages.


Public Properties
 PropertyDefined by
  activeProject : ProjectDetailsModel
The activeProject property is an instance of the ProjectDetailsModel class used as a transport object to be attached to the event object during dispatch at run time.
ProjectEvent
  properties : Object
The properties object acts as a flexible transport object to allow complex data to be attached to the event object during dispatch at run time.
ProjectEvent
Public Methods
 MethodDefined by
  
ProjectEvent(type:String = null, bubbles:Boolean = true, activeProject:ProjectDetailsModel = null, properties:Object = null)
Constructor.
ProjectEvent
Public Constants
 ConstantDefined by
  CONTENTS_LOAD : String = "contentsLoad"
[static] The ProjectEvent.CONTENTS_LOAD constant defines the value of the type property of the event object for a contentsLoad event.
ProjectEvent
  CONTENTS_SAVE : String = "contentsSave"
[static] The ProjectEvent.CONTENTS_SAVE constant defines the value of the type property of the event object for a contentsSave event.
ProjectEvent
  DOCUMENT_COMPLETE : String = "documentComplete"
[static] The ProjectEvent.DOCUMENT_COMPLETE constant defines the value of the type property of the event object for a documentComplete event.
ProjectEvent
  DOCUMENT_LOAD : String = "documentLoad"
[static] The ProjectEvent.DOCUMENT_LOAD constant defines the value of the type property of the event object for a documentLoad event.
ProjectEvent
  DOCUMENT_UNLOAD : String = "documentUnload"
[static] The ProjectEvent.DOCUMENT_UNLOAD constant defines the value of the type property of the event object for a documentUnload event.
ProjectEvent
  LINKS_LOAD : String = "linksLoad"
[static] The ProjectEvent.LINKS_LOAD constant defines the value of the type property of the event object for a linksLoad event.
ProjectEvent
  LINKS_SAVE : String = "linksSave"
[static] The ProjectEvent.LINKS_SAVE constant defines the value of the type property of the event object for a linksSave event.
ProjectEvent
  PAGE_CHANGED : String = "pageChanged"
[static] The ProjectEvent.PAGE_CHANGED constant defines the value of the type property of the event object for a pageChanged event.
ProjectEvent
  PAGE_GOTO : String = "pageGoto"
[static] The ProjectEvent.PAGE_GOTO constant defines the value of the type property of the event object for a pageGoto event.
ProjectEvent
  PROJECT_CLOSE : String = "projectClose"
[static] The ProjectEvent.PROJECT_CLOSE constant defines the value of the type property of the event object for a projectClose event.
ProjectEvent
  PROJECT_LOAD : String = "projectLoad"
[static] The ProjectEvent.PROJECT_LOAD constant defines the value of the type property of the event object for a projectLoad event.
ProjectEvent
  PROJECT_OPEN : String = "projectOpen"
[static] The ProjectEvent.PROJECT_OPEN constant defines the value of the type property of the event object for a projectOpen event.
ProjectEvent
Property detail
activeProjectproperty
public var activeProject:ProjectDetailsModel

The activeProject property is an instance of the ProjectDetailsModel class used as a transport object to be attached to the event object during dispatch at run time.

propertiesproperty 
public var properties:Object

The properties object acts as a flexible transport object to allow complex data to be attached to the event object during dispatch at run time.

Constructor detail
ProjectEvent()constructor
public function ProjectEvent(type:String = null, bubbles:Boolean = true, activeProject:ProjectDetailsModel = null, properties:Object = null)

Constructor. Typically instantiated inline within the dispatchEvent method.

Parameters
type:String (default = null) — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = true) — Specifies whether the event can bubble up the display list hierarchy.
 
activeProject:ProjectDetailsModel (default = null) — Is an instance of the ProjectDetailsModel class used as a transport object.
 
properties:Object (default = null) — A transport object to allow complex data to be attached to the event object during dispatch.
Constant detail
CONTENTS_LOADconstant
public static const CONTENTS_LOAD:String = "contentsLoad"

The ProjectEvent.CONTENTS_LOAD constant defines the value of the type property of the event object for a contentsLoad event.

CONTENTS_SAVEconstant 
public static const CONTENTS_SAVE:String = "contentsSave"

The ProjectEvent.CONTENTS_SAVE constant defines the value of the type property of the event object for a contentsSave event.

DOCUMENT_COMPLETEconstant 
public static const DOCUMENT_COMPLETE:String = "documentComplete"

The ProjectEvent.DOCUMENT_COMPLETE constant defines the value of the type property of the event object for a documentComplete event.

DOCUMENT_LOADconstant 
public static const DOCUMENT_LOAD:String = "documentLoad"

The ProjectEvent.DOCUMENT_LOAD constant defines the value of the type property of the event object for a documentLoad event.

DOCUMENT_UNLOADconstant 
public static const DOCUMENT_UNLOAD:String = "documentUnload"

The ProjectEvent.DOCUMENT_UNLOAD constant defines the value of the type property of the event object for a documentUnload event.

LINKS_LOADconstant 
public static const LINKS_LOAD:String = "linksLoad"

The ProjectEvent.LINKS_LOAD constant defines the value of the type property of the event object for a linksLoad event.

LINKS_SAVEconstant 
public static const LINKS_SAVE:String = "linksSave"

The ProjectEvent.LINKS_SAVE constant defines the value of the type property of the event object for a linksSave event.

PAGE_CHANGEDconstant 
public static const PAGE_CHANGED:String = "pageChanged"

The ProjectEvent.PAGE_CHANGED constant defines the value of the type property of the event object for a pageChanged event.

PAGE_GOTOconstant 
public static const PAGE_GOTO:String = "pageGoto"

The ProjectEvent.PAGE_GOTO constant defines the value of the type property of the event object for a pageGoto event.

PROJECT_CLOSEconstant 
public static const PROJECT_CLOSE:String = "projectClose"

The ProjectEvent.PROJECT_CLOSE constant defines the value of the type property of the event object for a projectClose event.

PROJECT_LOADconstant 
public static const PROJECT_LOAD:String = "projectLoad"

The ProjectEvent.PROJECT_LOAD constant defines the value of the type property of the event object for a projectLoad event.

PROJECT_OPENconstant 
public static const PROJECT_OPEN:String = "projectOpen"

The ProjectEvent.PROJECT_OPEN constant defines the value of the type property of the event object for a projectOpen event.