Packageflash.events
Classpublic class InvokeEvent
InheritanceInvokeEvent Inheritance Event Inheritance Object

Apollo dispatches an InvokeEvent event when an application is invoked. Apollo always dispatches an InvokeEvent event when an application is launched, but the event may be dispatched at other times as well. For example, a running application will receive an additional InvokeEvent when a user activates a file associated with the application.

Only a single instance of a particular application will be launched. Subsequent attempts to launch the application will result in a new invocation event on the running instance. It is an application's responsibility to handle the event and take the appropriate action, such as opening a new application window to display the data in a file.

Invocation events are dispatched through the Shell singleton object, which is automatically created for every Apollo application. To receive InvokeEvents, add a listener to the singleton Shell object. InvokeEvents are queued until a listener is registered. Since these events are queued, an application may receive several InvokeEvents when it registers the first listener, including the event for the start-up invocation.

See also

flash.system.Shell

Public Properties
 PropertyDefined by
  arguments : Array
[read-only] The array of string arguments passed during this invocation.
InvokeEvent
 Inheritedbubbles : Boolean
Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  currentDirectory : File
[read-only] The directory that should be used to resolve any relative paths in the arguments array.
InvokeEvent
 InheritedcurrentTarget : Object
The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
The current phase in the event flow.
Event
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedtarget : Object
The event target.
Event
 Inheritedtype : String
The type of event.
Event
Public Methods
 MethodDefined by
  
InvokeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, dir:File = null, argv:Array = null)
InvokeEvent
  
clone():Event
Creates a new copy of this event.
InvokeEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in your custom Event class.
Event
 Inherited
isDefaultPrevented():Boolean
Checks whether preventDefault() has been called on the event.
Event
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] Defines the value of the type property of an addedToStage event object.
Event
 InheritedCANCEL : String = "cancel"
[static] Defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] Defines the value of the type property of a change event object.
Event
 InheritedCLOSE : String = "close"
[static] Defines the value of the type property of a close event object.
Event
 InheritedCLOSING : String = "closing"
[static] Defines the value of the type property of a closing event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] Defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] Defines the value of the type property of a connect event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
 InheritedDOM_INITIALIZE : String = "domInitialize"
[static] Defines the value of the type property of a domInitialize event object.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] Defines the value of the type property of a fullScreen event object.
Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] Defines the value of the type property of an htmlBoundsChange event object.
Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] Defines the value of the type property of an htmlRender event object.
Event
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] Defines the value of the type property of an init event object.
Event
  INVOKE : String = "invoke"
[static] flash.events.InvokeEvent.INVOKE defines the value of the type property of an InvokeEvent event object.
InvokeEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] Defines the value of the type property of a locationChange event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] Defines the value of the type property of a networkChange event object.
Event
 InheritedOPEN : String = "open"
[static] Defines the value of the type property of an open event object.
Event
 InheritedREMOVED : String = "removed"
[static] Defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] Defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] Defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] Defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] Defines the value of the type property of a select event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] Defines the value of the type property of an unload event object.
Event
Property detail
argumentsproperty
arguments:Array  [read-only]

The array of string arguments passed during this invocation. If this is a command line invocation, the array will be the command line arguments excluding the process name.

Note: The Mac OS X Finder automatically passes the process serial number as an argument with the form -psn_NNN (where NNN is the process serial number).

Implementation
    public function get arguments():Array
currentDirectoryproperty 
currentDirectory:File  [read-only]

The directory that should be used to resolve any relative paths in the arguments array. If an application is started from the command line this property will typically be the current working directory of the command line shell from which it was started. If an application is launched from the GUI shell this is typically the file system root.

Implementation
    public function get currentDirectory():File
Constructor detail
InvokeEvent()constructor
public function InvokeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, dir:File = null, argv:Array = null)Parameters
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
 
dir:File (default = null)
 
argv:Array (default = null)
Method detail
clone()method
public override function clone():Event

Creates a new copy of this event.

Returns
Event
Constant detail
INVOKEconstant
public static const INVOKE:String = "invoke"

flash.events.InvokeEvent.INVOKE defines the value of the type property of an InvokeEvent event object.

The InvokeEvent object has the following properties:

PropertiesValues
argumentsthe array of string arguments passed during this invocation.
currentDirectorya File object representing the directory that should be used to resolve any relative paths in the arguments array.
bubblesNo.
cancelablefalse; There is no default behavior to cancel.
currentTargetIndicates the object that is actively processing this InvokeEvent object with an event listener.
targetAlways the Shell object.

See also

flash.system.Shell



© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Fri Mar 16 2007, 3:19 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/apollo/1.0/aslr/flash/events/InvokeEvent.html