| window.runtime property | window.runtime.flash.events.InvokeEvent |
| Inheritance | InvokeEvent Event Object |
Only a single instance of a particular application can be launched. Subsequent attempts to
launch the application will result in a new invoke 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.
InvokeEvent objects are dispatched by the NativeApplication object
(NativeApplication.nativeApplication). To receive InvokeEvent events,
call the addEventListener() method of the NativeApplication object.
When an event listener registers for an InvokeEvent event, it will also receive all InvokeEvent events
that occurred before the registration. These are dispatched after the call to addEventListener()
returns, but not necessarily before other InvokeEvent events that might be received after registration.
This lets you handle InvokeEvent events that have occurred before your initialization code
executes. Keep in mind that if you add an event listener later in execution (after application
initialization), it will still receive all InvokeEvent events that have occurred since the
application started.
See also
| Property | Defined By | ||
|---|---|---|---|
| arguments : Array
[read-only]
The array of string arguments passed during this invocation.
| InvokeEvent | ||
![]() | bubbles : Boolean
[read-only]
Indicates whether an event is a bubbling event.
| Event | |
![]() | cancelable : Boolean
[read-only]
Indicates whether the behavior associated with the event can be prevented.
| Event | |
![]() | constructor : 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 | ||
![]() | currentTarget : Object
[read-only]
The object that is actively processing the Event object with an event listener.
| Event | |
![]() | eventPhase : uint
[read-only]
The current phase in the event flow.
| Event | |
![]() | prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
![]() | target : Object
[read-only]
The event target.
| Event | |
![]() | type : String
[read-only]
The type of event.
| Event | |
| Method | Defined By | ||
|---|---|---|---|
|
InvokeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, dir:File = null, argv:Array = null)
The constructor function for the InvokeEvent class.
| InvokeEvent | ||
|
Creates a new copy of this event.
| InvokeEvent | ||
![]() |
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes.
| Event | |
![]() |
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
| Object | |
![]() |
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
| Event | |
![]() |
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
![]() |
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
| Event | |
![]() |
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
| Object | |
![]() |
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
| Object | |
![]() |
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow.
| Event | |
![]() |
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow.
| Event | |
![]() |
toString():String
Returns a string containing all the properties of the Event object.
| Event | |
![]() |
valueOf():Object
Returns the primitive value of the specified object.
| Object | |
| Constant | Defined By | ||
|---|---|---|---|
![]() | ACTIVATE : String = "activate" [static]
The Event.ACTIVATE constant defines the value of the type property of an activate event object.
| Event | |
![]() | ADDED : String = "added" [static]
The Event.ADDED constant defines the value of the type property of
an added event object.
| Event | |
![]() | ADDED_TO_STAGE : String = "addedToStage" [static]
The Event.ADDED_TO_STAGE constant defines defines the value of the type
property of an addedToStage event object.
| Event | |
![]() | CANCEL : String = "cancel" [static]
The Event.CANCEL constant defines the value of the type property of a cancel event object.
| Event | |
![]() | CHANGE : String = "change" [static]
The Event.CHANGE constant defines defines the value of the type property of a change event object.
| Event | |
![]() | CLOSE : String = "close" [static]
The Event.CLOSE constant defines the value of the type property of a close event object.
| Event | |
![]() | CLOSING : String = "closing" [static]
The Event.CLOSING constant defines the value of the type property of a closing event object.
| Event | |
![]() | COMPLETE : String = "complete" [static]
The Event.COMPLETE constant defines the value of the type property of a complete event object.
| Event | |
![]() | CONNECT : String = "connect" [static]
The Event.CONNECT constant defines the value of the type property of a connect event object.
| Event | |
![]() | DEACTIVATE : String = "deactivate" [static]
The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
| Event | |
![]() | DISPLAYING : String = "displaying" [static]
Defines the value of the type property of a displaying event object.
| Event | |
![]() | ENTER_FRAME : String = "enterFrame" [static]
The Event.ENTER_FRAME constant defines the value of the type property of
an enterFrame event object.
| Event | |
![]() | EXITING : String = "exiting" [static]
The Event.EXITING constant defines the value of the type property of a exiting event object.
| Event | |
![]() | FULLSCREEN : String = "fullScreen" [static]
The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
| Event | |
![]() | HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static]
The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
| Event | |
![]() | HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static]
The Event.HTML_DOM_INITIALIZE constant defines the value of the type property
of an htmlDOMInitialize event object.
| Event | |
![]() | HTML_RENDER : String = "htmlRender" [static]
The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
| Event | |
![]() | ID3 : String = "id3" [static]
The Event.ID3 constant defines the value of the type property of an id3 event object.
| Event | |
![]() | INIT : String = "init" [static]
The Event.INIT constant defines the value of the type property of an init event object.
| Event | |
| INVOKE : String = "invoke" [static]
The InvokeEvent.INVOKE constant defines the value of the type
property of an InvokeEvent event object.
| InvokeEvent | ||
![]() | LOCATION_CHANGE : String = "locationChange" [static]
The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
| Event | |
![]() | MOUSE_LEAVE : String = "mouseLeave" [static]
The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
| Event | |
![]() | NETWORK_CHANGE : String = "networkChange" [static]
The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
| Event | |
![]() | OPEN : String = "open" [static]
The Event.OPEN constant defines the value of the type property of an open event object.
| Event | |
![]() | REMOVED : String = "removed" [static]
The Event.REMOVED constant defines the value of the type property of
a removed event object.
| Event | |
![]() | REMOVED_FROM_STAGE : String = "removedFromStage" [static]
The Event.REMOVED_FROM_STAGE constant defines the value of the type
property of a removedFromStage event object.
| Event | |
![]() | RENDER : String = "render" [static]
The Event.RENDER constant defines the value of the type property of a render event object.
| Event | |
![]() | RESIZE : String = "resize" [static]
The Event.RESIZE constant defines the value of the type property of a resize event object.
| Event | |
![]() | SCROLL : String = "scroll" [static]
The Event.SCROLL constant defines the value of the type property of a scroll event object.
| Event | |
![]() | SELECT : String = "select" [static]
The Event.SELECT constant defines the value of the type property of a select event object.
| Event | |
![]() | SOUND_COMPLETE : String = "soundComplete" [static]
The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
| Event | |
![]() | TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
The Event.TAB_CHILDREN_CHANGE constant defines the value of the type
property of a tabChildrenChange event object.
| Event | |
![]() | TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
The Event.TAB_ENABLED_CHANGE constant defines the value of the type
property of a tabEnabledChange event object.
| Event | |
![]() | TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
The Event.TAB_INDEX_CHANGE constant defines the value of the
type property of a tabIndexChange event object.
| Event | |
![]() | UNLOAD : String = "unload" [static]
The Event.UNLOAD constant defines the value of the type property of an unload event object.
| Event | |
![]() | USER_IDLE : String = "userIdle" [static]
The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
| Event | |
![]() | USER_PRESENT : String = "userPresent" [static]
The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
| Event | |
| arguments | property |
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: When multiple files are selected and opened on Mac OS X, AIR will
dispatch a single invoke event containing the names of all the
selected files in the arguments property. On Windows, however, AIR will
dispatch a separate invoke event for each selected file containing only that
filename as in the arguments array.
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).
| currentDirectory | property |
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 is
typically set to the current working directory of the command line shell from which
the application was started. If an application is launched from the GUI shell,
this is typically the file system root.
| InvokeEvent | () | Constructor |
function InvokeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, dir:File = null, argv:Array = null)
The constructor function for the InvokeEvent class.
Typically you would not call the InvokeEvent() constructor directly.
Only the AIR runtime should create a InvokeEvent object.
type:String — The type of the event, accessible as Event.type.
|
|
bubbles:Boolean (default = false) — Set to false for an InvokeEvent object.
|
|
cancelable:Boolean (default = false) — Set to false for an InvokeEvent object.
|
|
dir:File (default = null) — The directory that should be used to resolve any relative paths in
the arguments array.
|
|
argv:Array (default = null) — An array of arguments (strings) to pass to the application.
|
| clone | () | method |
| INVOKE | Constant |
public static const INVOKE:String = "invoke"
The constant defines the value of the type
property of an InvokeEvent event object.
The InvokeEvent object has the following properties:
| Properties | Values |
|---|---|
arguments | the array of string arguments passed during this invocation. |
currentDirectory | a object representing the directory that should be used to resolve any relative paths in the arguments array. |
bubbles | No. |
cancelable | false;
There is no default behavior to cancel. |
currentTarget | Indicates the object that is actively processing this InvokeEvent object with an event listener. |
target | Always the object. |
See also
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/labs/air/1/jslr/flash/events/InvokeEvent.html