View source

class NativeApplication

package openfl.desktop

extends EventDispatcher

@:directlyUsed

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

The NativeApplication class represents this OpenFL application.

The NativeApplication class provides application information, application-wide functions, and dispatches application-level events.

The NativeApplication object is a singleton object, created automatically at startup. Get the NativeApplication instance of an application with the static property NativeApplication.nativeApplication.

Static variables

staticread onlynativeApplication:NativeApplication

The singleton instance of the NativeApplication object.

staticread onlysupportsDefaultApplication:Bool

Indicates whether setAsDefaultApplication(), removeAsDefaultApplication(), and isSetAsDefaultApplication() are supported on the current platform.

OpenFL target support: Not currently supported, except when targeting AIR.

If true, then the above methods will work as documented. If false, then setAsDefaultApplication() and removeDefaultApplication() do nothing and isSetAsDefaultApplication() returns false.

See also:

staticread onlysupportsDockIcon:Bool

Indicates whether OpenFL supports dock-style application icons on the current operating system.

OpenFL target support: Not currently supported, except when targeting AIR.

If true, the NativeApplication.icon property is of type DockIcon.

The Mac OS X user interface provides an application "dock" containing icons for applications that are running or are frequently used.

Be sure to use the NativeApplication.supportsDockIcon property to determine whether the operating system supports application dock icons. Using other means (such as Capabilities.os) to determine support can lead to programming errors (if some possible target operating systems are not considered).

staticread onlysupportsMenu:Bool

Specifies whether the current operating system supports a global application menu bar.

OpenFL target support: Not currently supported, except when targeting AIR.

When true, the NativeApplication.menu property can be used to define (or access) a native application menu.

Be sure to use the NativeApplication.supportsMenu property to determine whether the operating system supports the application menu bar. Using other means (such as Capabilities.os) to determine support can lead to programming errors (if some possible target operating systems are not considered).

staticread onlysupportsStartAtLogin:Bool

Indicates whether startAtLogin is supported on the current platform.

OpenFL target support: Not currently supported, except when targeting AIR.

If true, then startAtLogin works as documented. If false, then startAtLogin has no effect.

See also:

staticread onlysupportsSystemTrayIcon:Bool

Specifies whether OpenFL supports system tray icons on the current operating system.

OpenFL target support: Not currently supported, except when targeting AIR.

If true, the NativeApplication.icon property is of type SystemTrayIcon.

The Windows user interface provides the "system tray" region of the task bar, officially called the Notification Area, in which application icons can be displayed. No default icon is shown. You must set the bitmaps array of the icon object to display an icon.

Be sure to use the NativeApplication.supportsSystemTrayIcon property to determine whether the operating system supports system tray icons. Using other means (such as Capabilities.os) to determine support can lead to programming errors (if some possible target operating systems are not considered).

Variables

read onlyactiveWindow:NativeWindow

The active application window.

If the active desktop window does not belong to this application, or there is no active window, activeWindow is null.

This property is not supported on platforms that do not support the NativeWindow class.

read onlyapplicationID:String

The application ID of this application.

The value of this ID is set in the application descriptor file.

@:value(true)autoExit:Bool = true

Specifies whether the application should automatically terminate when all windows have been closed.

When autoExit is true, which is the default, the application terminates when all windows are closed. Both exiting and exit events are dispatched. When autoExit is false, you must call NativeApplication.nativeApplication.exit() to terminate the application.

This property is not supported on platforms that do not support the NativeWindow class.

@:value(null)read onlyicon:InteractiveIcon = null

The application icon.

OpenFL target support: Not currently supported, except when targeting AIR.

Use NativeApplication.supportsDockIcon and NativeApplication.supportsSystemTrayIcon to determine the icon class. The type will be one of the subclasses of InteractiveIcon. On macOS, NativeApplication.icon is an object of type DockIcon. On Windows, NativeApplication.icon is an object of type SystemTrayIcon. When an application icon is not supported, NativeApplication.supportsDockIcon and NativeApplication.supportsSystemTrayIcon are both false and the icon property is null.

The icon object is automatically created, but it is not initialized with image data. On some operating systems, such as macOS, a default image is supplied. On others, such as Windows, the icon is not displayed unless image data is assigned to it. To assign an icon image, set the icon.bitmaps property with an array containing at least one BitmapData object. If more than one BitmapData object is included in the array, then the operating system chooses the image that is closest in size to the icon's display dimensions, scaling the image if necessary.

read onlyisCompiledAOT:Bool

In Adobe AIR, when targeting iOS, this property indicates if the application was compiled AOT or if code is using the slower interpreter without JIT. On all other platforms and operating systems, this property returns false.

read onlyopenedWindows:Array<NativeWindow>

An array containing all the open native windows of this application.

This property is not supported on platforms that do not support the NativeWindow class.

startAtLogin:Bool

Specifies whether this application is automatically launched whenever the current user logs in.

You can test for support at run time using the NativeApplication.supportsStartAtLogin property.

OpenFL target support: Not currently supported, except when targeting AIR.

Adobe AIR profile support: This feature is supported on all desktop operating systems, but is not supported on mobile devices or AIR for TV devices. See AIR Profile Support for more information regarding API support across multiple profiles.

The startAtLogin property reflects the status of the operating-system-defined mechanism for designating that an application should start automatically when a user logs in. The user can change the status manually by using the operating system user interface. This property reflects the current status, whether the status was last changed by the application or by the operating system.

See also:

Methods

@:value({ code : 0 })exit(code:Int = 0):Void

Terminates this application.

The call to the exit() method will return; the shutdown sequence does not begin until the currently executing code (such as a current event handler) has completed. Pending asynchronous operations are canceled and may or may not complete.

Note that an exiting event is not dispatched. If an exiting event is required by application logic, call NativeApplication.nativeApplication.dispatchEvent(), passing in an Event object of type exiting. For any open windows, NativeWindow objects do dispatch closing and close events. Calling the preventDefault() method of closing event object prevents the application from exiting.

Note: This method is not supported on the iOS operating system.

isSetAsDefaultApplication(extension:String):Bool

Specifies whether this application is currently the default application for opening files with the specified extension.

You can test for support at run time using the NativeApplication.supportsDefaultApplication property.

OpenFL target support: Not currently supported, except when targeting AIR.

Adobe AIR profile support: This feature is supported on all desktop operating systems, but is not supported on mobile devices or AIR for TV devices. See AIR Profile Support for more information regarding API support across multiple profiles.

removeAsDefaultApplication(extension:String):Void

Removes this application as the default for opening files with the specified extension.

OpenFL target support: Not currently supported, except when targeting AIR.

Note: This method can only be used with file types listed in the fileTypes statement in the application descriptor.

setAsDefaultApplication(extension:String):Void

Sets this application as the default application for opening files with the specified extension.

OpenFL target support: Not currently supported, except when targeting AIR.

Note: This method can only be used with file types declared in the fileTypes statement in the application descriptor.

Inherited Variables

Inherited Methods

Defined by EventDispatcher

@:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeListener(). Then you can register the listener again with the new priority level.

Keep in mind that after the listener is registered, subsequent calls to addEventListener() with a different type or useCapture value result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

If you no longer need an event listener, remove it by calling removeEventListener(), or memory problems could result. Event listeners are not automatically removed from memory because the garbage collector does not remove the listener as long as the dispatching object exists(unless the useWeakReference parameter is set to true).

Copying an EventDispatcher instance does not copy the event listeners attached to it.(If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is being processed on this node, the event listener is not triggered during the current phase but can be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again(unless registered again for future processing).

Parameters:

type

The type of event.

useCapture

Determines whether the listener works in the capture phase or the target and bubbling phases. If useCapture is set to true, the listener processes the event only during the capture phase and not in the target or bubbling phase. If useCapture is false, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call addEventListener twice, once with useCapture set to true, then again with useCapture set to false.

priority

The priority level of the event listener. The priority is designated by a signed 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.

useWeakReference

Determines whether the reference to the listener is strong or weak. A strong reference(the default) prevents your listener from being garbage-collected. A weak reference does not.

Class-level member functions are not subject to garbage collection, so you can set useWeakReference to true for class-level member functions without subjecting them to garbage collection. If you set useWeakReference to true for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

Weak references are supported on some OpenFL targets only, including html5, cpp, and flash/air. On other targets, this parameter is ignored, and the reference will be strong instead.

Throws:

ArgumentError

The listener specified is not a function.

dispatchEvent(event:Event):Bool

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which the dispatchEvent() method is called.

Parameters:

event

The Event object that is dispatched into the event flow. If the event is being redispatched, a clone of the event is created automatically. After an event is dispatched, its target property cannot be changed, so you must create a new copy of the event for redispatching to work.

Returns:

A value of true if the event was successfully dispatched. A value of false indicates failure or that preventDefault() was called on the event.

Throws:

Error

The event dispatch recursion limit has been reached.

hasEventListener(type:String):Bool

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type actually triggers an event listener, use willTrigger().

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

When hasEventListener() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

Parameters:

type

The type of event.

Returns:

A value of true if a listener of the specified type is registered; false otherwise.

@:value({ useCapture : false })removeEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false):Void

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters:

type

The type of event.

useCapture

Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to removeEventListener() are required to remove both, one call with useCapture() set to true, and another call with useCapture() set to false.

toString():String

willTrigger(type:String):Bool

Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

The difference between the hasEventListener() and the willTrigger() methods is that hasEventListener() examines only the object to which it belongs, whereas the willTrigger() method examines the entire event flow for the event specified by the type parameter.

When willTrigger() is called from a LoaderInfo object, only the listeners that the caller can access are considered.

Parameters:

type

The type of event.

Returns:

A value of true if a listener of the specified type will be triggered; false otherwise.