View source

class InvokeEvent

package openfl.events

extends Event

@:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

The NativeApplication object of an OpenFL application dispatches an invoke event when the application is invoked.

The NativeApplication object always dispatches an invoke event when an application is launched, but the event may be dispatched at other times as well. For example, a running application dispatches an additional InvokeEvent when a user activates a file associated with the application.

Only a single instance of a particular application can be launched. Subsequent attempts to launch the application will result in a new invoke event dispatched by the NativeApplication object of the running instance. It is an application's responsibility to handle this 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 global NativeApplication object (NativeApplication.nativeApplication). To receive invoke events, call the addEventListener() method of the NativeApplication object. When an event listener registers for an invoke event, it will also receive all invoke events that occurred before the registration. These earlier events are dispatched after the call to addEventListener() returns, but not necessarily before a new invoke event that might be might be dispatched after registration. Thus, you should not rely on dispatch order.

Static variables

@:value("invoke")staticinlineread onlyINVOKE:EventType<InvokeEvent> = "invoke"

The InvokeEvent.INVOKE constant defines the value of the type property of an InvokeEvent object.

Constructor

@:value({ reason : STANDARD, cancelable : false, bubbles : false })new(type:EventType<InvokeEvent>, bubbles:Bool = false, cancelable:Bool = false, ?dir:File, ?argv:Array<Dynamic>, reason:InvokeEventReason = STANDARD)

Variables

read onlyarguments:Array<String>

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

On mobile platforms, this property contains the array of options with which the application was launched, not the command-line arguments. Additionally, on mobile platforms, when reason is InvokeEventReason.OPEN_URL, the contents of the arguments array vary, as follows:

Note: When multiple files are selected and opened on macOS, OpenFL dispatches a single invoke event containing the names of all the selected files in the arguments array. On Windows and Linux, however, OpenFL dispatches a separate invoke event for each selected file containing only that filename in the arguments array.

read onlycurrentDirectory:File

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.

read onlyreason:InvokeEventReason

The reason for this InvokeEvent. This property indicates whether the application was launched manually by the user or automatically at login. Possible values are enumerated as constants in the InvokeEventReason class:

InvokeEventReason constantMeaning
LOGINLaunched automatically at at login.
NOTIFICATIONLaunched in reponse to a notification (iOS only).
OPEN_URLLaunched because the application was invoked by another application.
STANDARDLaunched for any other reason.

Note: On mobile platforms, the reason property is never set to LOGIN.

Methods

Inherited Variables

Defined by Event

read onlybubbles:Bool

Indicates whether an event is a bubbling event. If the event can bubble, this value is true; otherwise it is false.

When an event occurs, it moves through the three phases of the event flow: the capture phase, which flows from the top of the display list hierarchy to the node just before the target node; the target phase, which comprises the target node; and the bubbling phase, which flows from the node subsequent to the target node back up the display list hierarchy.

Some events, such as the activate and unload events, do not have a bubbling phase. The bubbles property has a value of false for events that do not have a bubbling phase.

read onlycancelable:Bool

Indicates whether the behavior associated with the event can be prevented. If the behavior can be canceled, this value is true; otherwise it is false.

read onlycurrentTarget:Object

The object that is actively processing the Event object with an event listener. For example, if a user clicks an OK button, the current target could be the node containing that button or one of its ancestors that has registered an event listener for that event.

read onlyeventPhase:EventPhase

The current phase in the event flow. This property can contain the following numeric values:

read onlytarget:Object

The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

read onlytype:String

The type of event. The type is case-sensitive.

Inherited Methods

Defined by Event

@:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

A utility function for implementing the toString() method in custom OpenFL Event classes. Overriding the toString() method is recommended, but not required.

class PingEvent extends Event {
	var URL:String;

	public function new() {
		super();
	}

	public override function toString():String {
		return formatToString("PingEvent", "type", "bubbles", "cancelable", "eventPhase", "URL");
	}
}

Parameters:

className

The name of your custom Event class. In the previous example, the className parameter is PingEvent.

Returns:

The name of your custom Event class and the String value of your ...arguments parameter.

isDefaultPrevented():Bool

Checks whether the preventDefault() method has been called on the event. If the preventDefault() method has been called, returns true; otherwise, returns false.

Returns:

If preventDefault() has been called, returns true; otherwise, returns false.

preventDefault():Void

Cancels an event's default behavior if that behavior can be canceled. Many events have associated behaviors that are carried out by default. For example, if a user types a character into a text field, the default behavior is that the character is displayed in the text field. Because the TextEvent.TEXT_INPUT event's default behavior can be canceled, you can use the preventDefault() method to prevent the character from appearing. An example of a behavior that is not cancelable is the default behavior associated with the Event.REMOVED event, which is generated whenever Flash Player is about to remove a display object from the display list. The default behavior (removing the element) cannot be canceled, so the preventDefault() method has no effect on this default behavior. You can use the Event.cancelable property to check whether you can prevent the default behavior associated with a particular event. If the value of Event.cancelable is true, then preventDefault() can be used to cancel the event; otherwise, preventDefault() has no effect.

stopImmediatePropagation():Void

Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. This method takes effect immediately, and it affects event listeners in the current node. In contrast, the stopPropagation() method doesn't take effect until all the event listeners in the current node finish processing.

Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

stopPropagation():Void

Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

toString():String

Returns a string containing all the properties of the Event object. The string is in the following format:

[Event type=_value_ bubbles=_value_ cancelable=_value_]

Returns:

A string containing all the properties of the Event object.