diff --git a/src/openfl/desktop/Clipboard.hx b/src/openfl/desktop/Clipboard.hx
index f6f4618c56..a39891ed6b 100644
--- a/src/openfl/desktop/Clipboard.hx
+++ b/src/openfl/desktop/Clipboard.hx
@@ -457,7 +457,7 @@ class Clipboard
use a handler function to provide the data for a file dragged from an
AIR application to the file system, the operating system calls the
data handler function as soon as the drag gesture leaves the AIR
- application?typically resulting in an undesireable pause as the file
+ application — typically resulting in an undesireable pause as the file
data is downloaded or created. You can use a URLFilePromise for this
purpose instead.
diff --git a/src/openfl/desktop/NativeApplication.hx b/src/openfl/desktop/NativeApplication.hx
index 6789104d34..b0d2829e04 100644
--- a/src/openfl/desktop/NativeApplication.hx
+++ b/src/openfl/desktop/NativeApplication.hx
@@ -9,7 +9,7 @@ import openfl.events.EventDispatcher;
import openfl.utils._internal.Lib;
/**
- The NativeApplication class represents this AIR application.
+ The NativeApplication class represents this OpenFL application.
The NativeApplication class provides application information,
application-wide functions, and dispatches application-level events.
@@ -42,6 +42,8 @@ class NativeApplication extends EventDispatcher
`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`.
@@ -58,9 +60,11 @@ class NativeApplication extends EventDispatcher
}
/**
- Indicates whether AIR supports dock-style application icons on the
+ 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
@@ -83,6 +87,8 @@ class NativeApplication extends EventDispatcher
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.
@@ -102,6 +108,8 @@ class NativeApplication extends EventDispatcher
/**
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.
@@ -115,9 +123,11 @@ class NativeApplication extends EventDispatcher
}
/**
- Specifies whether AIR supports system tray icons on the current
+ 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`.
@@ -199,6 +209,8 @@ class NativeApplication extends EventDispatcher
/**
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,
@@ -328,6 +340,8 @@ class NativeApplication extends EventDispatcher
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.
**/
@@ -337,6 +351,8 @@ class NativeApplication extends EventDispatcher
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.
**/
diff --git a/src/openfl/desktop/NativeProcess.hx b/src/openfl/desktop/NativeProcess.hx
index 303bc3d415..fceebe55ed 100644
--- a/src/openfl/desktop/NativeProcess.hx
+++ b/src/openfl/desktop/NativeProcess.hx
@@ -35,14 +35,15 @@ import haxe.io.BytesOutput;
/**
The NativeProcess class provides command line integration and general
- launching capabilities. The NativeProcess class lets an AIR application
- execute native processes on the host operating system. The AIR applcation
- can monitor the standard input (stdin) and standard output (stdout) stream
- of the process as well as the process's standard error (stderr) stream.
+ launching capabilities. The NativeProcess class lets an OpenFL application
+ execute native processes on the host operating system. The OpenFL
+ application can monitor the standard input (stdin) and standard output
+ (stdout) stream of the process as well as the process's standard error
+ (stderr) stream.
The NativeProcess class and its capabilities are only available to Haxe
"sys" targets and AIR applications installed with a native installer
- (extended desktop profile applications). When debugging an AIR application,
+ ("extendedDesktop" profile applications). When debugging an AIR application,
you can pass the `-profile extendedDesktop` argument to ADL to enable the
NativeProcess functionality. At runtime, you can check the
`NativeProcess.isSupported` property to to determine whether native process
@@ -56,12 +57,13 @@ import haxe.io.BytesOutput;
class NativeProcess extends EventDispatcher
{
/**
- ndicates if running native processes is supported in the current
- profile. This property returns `true` only when running on Haxe "sys"
- targets or the Adobe AIR extendedDesktop profile. In addition,
+ Indicates if running native processes is supported in the current
+ OpenFL target. This property returns `true` only when running on Haxe
+ "sys" targets or the Adobe AIR "extendedDesktop" profile. In addition,
`NativeProcess.isSupported` is always `false` for applications installed
as an `.air` file. You must package an AIR application using the ADT
- `-target native` flag in order to use the NativeProcess class in AIR.
+ `-target native` flag or the `-target bundle` flag in order to use the
+ NativeProcess class in AIR.
**/
public static var isSupported(default, never):Bool = true;
diff --git a/src/openfl/desktop/NativeProcessStartupInfo.hx b/src/openfl/desktop/NativeProcessStartupInfo.hx
index bc77a60e5a..2040b74d59 100644
--- a/src/openfl/desktop/NativeProcessStartupInfo.hx
+++ b/src/openfl/desktop/NativeProcessStartupInfo.hx
@@ -9,9 +9,9 @@ import openfl.filesystem.File;
host operating system. It is constructed and passed to the `start()` method
of a NativeProcess object.
- Native process access is only available to AIR applications installed with
- native installers (applications in the extended desktop profile) and Haxe
- "sys" targets.
+ Native process access is only available to Haxe "sys" targets and AIR
+ applications installed with native installers (applications in the
+ "extendedDesktop" profile).
**/
#if !openfl_debug
@:fileXml('tags="haxe,release"')
diff --git a/src/openfl/display/InteractiveObject.hx b/src/openfl/display/InteractiveObject.hx
index 47e38e0a4c..b8d0ffe76e 100644
--- a/src/openfl/display/InteractiveObject.hx
+++ b/src/openfl/display/InteractiveObject.hx
@@ -43,7 +43,7 @@ import openfl.geom.Rectangle;
`click` event still occurs.
@event contextMenu Dispatched when a user gesture triggers the
context menu associated with this interactive
- object in an AIR application.
+ object in an OpenFL application.
@event copy Dispatched when the user activates the
platform-specific accelerator key combination
for a copy operation or selects 'Copy' from
diff --git a/src/openfl/display/NativeWindow.hx b/src/openfl/display/NativeWindow.hx
index 8ff230cdca..4cd4dd48ac 100644
--- a/src/openfl/display/NativeWindow.hx
+++ b/src/openfl/display/NativeWindow.hx
@@ -24,7 +24,7 @@ import openfl.geom.Point;
`NativeWindow.isSupported` property.
_OpenFL target support:_ This feature is supported on all desktop operating
- systems, but is not support on mobile operating systems, including iOS and
+ systems, but is not supported on mobile operating systems, including iOS and
Android.
_Adobe AIR profile support:_ This feature is supported on all desktop
diff --git a/src/openfl/display/Stage.hx b/src/openfl/display/Stage.hx
index 79f59c7015..93e896b5ba 100644
--- a/src/openfl/display/Stage.hx
+++ b/src/openfl/display/Stage.hx
@@ -268,7 +268,6 @@ class Stage extends DisplayObjectContainer #if lime implements IModule #end
**/
// @:noCompletion @:dox(hide) @:require(flash10) public var colorCorrection:openfl.display.ColorCorrection;
#end
-
#if false
/**
Specifies whether the Flash runtime is running on an operating system
@@ -312,14 +311,13 @@ class Stage extends DisplayObjectContainer #if lime implements IModule #end
A value from the StageDisplayState class that specifies which display
state to use. The following are valid values:
- * `StageDisplayState.FULL_SCREEN` Sets AIR application or
- Flash runtime to expand the stage over the user's entire screen, with
- keyboard input disabled.
- * `StageDisplayState.FULL_SCREEN_INTERACTIVE` Sets the AIR
+ * `StageDisplayState.FULL_SCREEN` Sets the OpenFL application to expand
+ the stage over the user's entire screen, with keyboard input disabled.
+ * `StageDisplayState.FULL_SCREEN_INTERACTIVE` Sets the OpenFL
application to expand the stage over the user's entire screen, with
- keyboard input allowed.(Not available for content running in Flash
- Player.)
- * `StageDisplayState.NORMAL` Sets the Flash runtime back to
+ keyboard input allowed. (Not available for content running in Adobe
+ Flash Player.)
+ * `StageDisplayState.NORMAL` Sets the OpenFL application back to
the standard stage display mode.
diff --git a/src/openfl/events/EventDispatcher.hx b/src/openfl/events/EventDispatcher.hx
index 0658d6d1c6..af74c3cc8f 100644
--- a/src/openfl/events/EventDispatcher.hx
+++ b/src/openfl/events/EventDispatcher.hx
@@ -8,13 +8,12 @@ package openfl.events;
class allows any object on the display list to be an event target and as
such, to use the methods of the IEventDispatcher interface.
- Event targets are an important part of the Flash® Player and
- Adobe® AIR® event model. The event target serves as
- the focal point for how events flow through the display list hierarchy.
- When an event such as a mouse click or a keypress occurs, Flash Player or
- the AIR application dispatches an event object into the event flow from the
- root of the display list. The event object then makes its way through the
- display list until it reaches the event target, at which point it begins
+ Event targets are an important part of the OpenFL event model. The event
+ target serves as the focal point for how events flow through the display
+ list hierarchy. When an event such as a mouse click or a keypress occurs,
+ the OpenFL application dispatches an event object into the event flow fro
+ the root of the display list. The event object then makes its way through
+ the display list until it reaches the event target, at which point it begins
its return trip through the display list. This round-trip journey to the
event target is conceptually divided into three phases: the capture phase
comprises the journey from the root to the last node before the event
@@ -29,14 +28,14 @@ package openfl.events;
EventDispatcher member, and write simple hooks to route calls into the
aggregated EventDispatcher.
- @event activate [broadcast event] Dispatched when the Flash Player or AIR
- application gains operating system focus and becomes
+ @event activate [broadcast event] Dispatched when the OpenFL application
+ gains operating system focus and becomes
active. This event is a broadcast event, which means that
it is dispatched by all EventDispatcher objects with a
listener registered for this event. For more information
about broadcast events, see the DisplayObject class.
- @event deactivate [broadcast event] Dispatched when the Flash Player or AIR
- application operating loses system focus and is becoming
+ @event deactivate [broadcast event] Dispatched when the OpenFL application
+ loses operating system focus and is becoming
inactive. This event is a broadcast event, which means
that it is dispatched by all EventDispatcher objects with
a listener registered for this event. For more
diff --git a/src/openfl/filesystem/File.hx b/src/openfl/filesystem/File.hx
index 1f3fd4bb46..37bed81051 100644
--- a/src/openfl/filesystem/File.hx
+++ b/src/openfl/filesystem/File.hx
@@ -70,7 +70,7 @@ import lime.system.BackgroundWorker;
```
The application storage directory is particularly useful. It gives an application-specific
- storage directory for the AIR application. It is defined by the File.applicationStorageDirectory
+ storage directory for the OpenFL application. It is defined by the File.applicationStorageDirectory
property.
@see [Related: FileStream](https://api.openfl.org/openfl/filesystem/FileStream.html)
diff --git a/src/openfl/net/DatagramSocket.hx b/src/openfl/net/DatagramSocket.hx
index 110192ece9..100e439b1b 100644
--- a/src/openfl/net/DatagramSocket.hx
+++ b/src/openfl/net/DatagramSocket.hx
@@ -24,7 +24,8 @@ import sys.net.UdpSocket;
property.
_OpenFL target support:_ This feature is supported on all desktop operating
- systems, on iOS, and on Android.
+ systems, on iOS, and on Android. This feature is not supported on the html5
+ target or other non-sys targets.
_Adobe AIR profile support:_ his feature is supported on all desktop
operating systems, on iOS (starting with AIR 3.8), and on Android (starting
diff --git a/src/openfl/net/FileFilter.hx b/src/openfl/net/FileFilter.hx
index 7bc21157a5..58d50287ed 100644
--- a/src/openfl/net/FileFilter.hx
+++ b/src/openfl/net/FileFilter.hx
@@ -30,7 +30,7 @@ package openfl.net;
myFileReference.browse([imagesFilter, docFilter]);
```
- Or in an AIR application:
+ Or in an OpenFL desktop application:
```haxe
var imagesFilter = new FileFilter("Images", "*.jpg;*.gif;*.png");
diff --git a/src/openfl/net/FileReference.hx b/src/openfl/net/FileReference.hx
index b0d7b76d3b..9c9a206d3a 100644
--- a/src/openfl/net/FileReference.hx
+++ b/src/openfl/net/FileReference.hx
@@ -287,19 +287,17 @@ import js.Browser;
AIR runtime, the `select` event acts slightly
differently depending on what method invokes it.
When the `select` event is dispatched after a
- `browse()` call, Flash Player or the AIR
- application can read all the FileReference
- object's properties, because the file selected
- by the user is on the local file system. When
- the `select` event occurs after a `download()`
- call, Flash Player or the AIR application can
- read only the `name` property, because the file
- hasn't yet been downloaded to the local file
- system at the moment the `select` event is
- dispatched. When the file is downloaded and the
- `complete` event dispatched, Flash Player or the
- AIR application can read all other properties of
- the FileReference object.
+ `browse()` call, the OpenFL application can read
+ all the FileReference object's properties, because
+ the file selected by the user is on the local file
+ system. When the `select` event occurs after a
+ `download()` call, the OpenFL application can read
+ only the `name` property, because the file hasn't
+ yet been downloaded to the local file system at the
+ moment the `select` event is dispatched. When the
+ file is downloaded and the `complete` even
+ dispatched, the OpenFL application can read all
+ other properties of the FileReference object.
@event uploadCompleteData Dispatched after data is received from the
server after a successful upload. This event is
not dispatched if data is not returned from the
diff --git a/src/openfl/net/SecureSocket.hx b/src/openfl/net/SecureSocket.hx
index 976389207c..792520d657 100644
--- a/src/openfl/net/SecureSocket.hx
+++ b/src/openfl/net/SecureSocket.hx
@@ -30,7 +30,8 @@ import sys.ssl.Socket as SysSecureSocket;
You can test for support at run time using the `SecureSocket.isSupported`
property.
- _OpenFL target support:_ This feature is not supported on all platforms.
+ _OpenFL target support:_ This feature is supported on all desktop operating
+ systems, on iOS, and on Android. It is not supported on non-sys targets.
_Adobe AIR profile support:_ This feature is supported on all desktop
operating systems, but is not supported on all AIR for TV devices. On mobile
diff --git a/src/openfl/net/ServerSocket.hx b/src/openfl/net/ServerSocket.hx
index 7769ed908b..33a3d8389c 100644
--- a/src/openfl/net/ServerSocket.hx
+++ b/src/openfl/net/ServerSocket.hx
@@ -23,7 +23,8 @@ import sys.net.Socket;
property.
_OpenFL target support:_ This feature is supported on all desktop operating
- systems, on iOS, and on Android. This feature is not supported on html5.
+ systems, on iOS, and on Android. This feature is not supported on the html5
+ target or other non-sys targets.
_Adobe AIR profile support:_ This feature is supported on all desktop
operating systems, on iOS (starting with AIR 3.8), and on Android (starting
@@ -50,7 +51,7 @@ import sys.net.Socket;
serious network failure occurs). Any data sent over the connection is broken into transmittable
packets and reassembled on the other end. All packets are guaranteed to arrive (within reason) —
any lost packets are retransmitted. In general, the TCP protocol manages the available network
- bandwidth better than the UDP protocol. Most AIR applications that require socket communications
+ bandwidth better than the UDP protocol. Most OpenFL applications that require socket communications
should use the ServerSocket and Socket classes rather than the DatagramSocket class.
The ServerSocket class can only be used in targets that support TCP.
@@ -96,8 +97,8 @@ class ServerSocket extends EventDispatcher
/**
Creates a ServerSocket object.
- @throws SecurityError This error occurs ff the calling content is running outside the AIR
- application security sandbox.
+ @throws SecurityError This error occurs if the calling content is
+ running outside the AIR application security sandbox.
**/
public function new()
{
diff --git a/src/openfl/net/Socket.hx b/src/openfl/net/Socket.hx
index a230a9cb02..79a09a4912 100644
--- a/src/openfl/net/Socket.hx
+++ b/src/openfl/net/Socket.hx
@@ -44,6 +44,10 @@ import sys.net.Socket as SysSocket;
A socket transmits and receives data asynchronously.
+ _OpenFL target support:_ This feature is supported on all desktop operating
+ systems, on iOS, and on Android. On the html5 target, it uses web sockets
+ instead of raw unix-style sockets.
+
On some operating systems, flush() is called automatically between
execution frames, but on other operating systems, such as Windows, the
data is never sent unless you call `flush()` explicitly. To ensure your
diff --git a/src/openfl/net/URLRequest.hx b/src/openfl/net/URLRequest.hx
index aa6cc0c59d..977e323649 100644
--- a/src/openfl/net/URLRequest.hx
+++ b/src/openfl/net/URLRequest.hx
@@ -19,19 +19,17 @@ import haxe.macro.Compiler;
from sources that are also at www.adobe.com. To load data from a different
domain, place a URL policy file on the server hosting the data.
- However, in Adobe AIR, content in the application security sandbox
+ However, in Adobe AIR, content in the application security sandbox
(content installed with the AIR application) is not restricted by these
security limitations. For content running in Adobe AIR, files in the
application security sandbox can access URLs using any of the following URL
schemes:
-
* `http` and `https`
* `file`
* `app-storage`
* `app`
-
Content running in Adobe AIR that is not in the application security
sandbox observes the same restrictions as content running in the browser
(in Flash Player), and loading is governed by the content's domain and any
diff --git a/src/openfl/net/URLRequestHeader.hx b/src/openfl/net/URLRequestHeader.hx
index 14891b28c3..5e6ac7c1f5 100644
--- a/src/openfl/net/URLRequestHeader.hx
+++ b/src/openfl/net/URLRequestHeader.hx
@@ -7,7 +7,7 @@ package openfl.net;
`requestHeaders` property of the URLRequest class.
In Adobe® AIR®, content in the application
- security sandbox(such as content installed with the AIR application) can
+ security sandbox (such as content installed with the AIR application) can
use any request headers, without error. However, for content running in
Adobe AIR that is in a different security sandbox, or for content running
in Flash® Player, using following request headers cause a
diff --git a/src/openfl/net/XMLSocket.hx b/src/openfl/net/XMLSocket.hx
index d8854c55fa..e9c99340b5 100644
--- a/src/openfl/net/XMLSocket.hx
+++ b/src/openfl/net/XMLSocket.hx
@@ -9,19 +9,19 @@ import openfl.events.ProgressEvent;
import openfl.utils.ByteArray;
/**
- The XMLSocket class implements client sockets that let the Flash Player or
- AIR application communicate with a server computer identified by an IP
- address or domain name. The XMLSocket class is useful for client-server
- applications that require low latency, such as real-time chat systems. A
- traditional HTTP-based chat solution frequently polls the server and
- downloads new messages using an HTTP request. In contrast, an XMLSocket
- chat solution maintains an open connection to the server, which lets the
- server immediately send incoming messages without a request from the
- client. To use the XMLSocket class, the server computer must run a daemon
- that understands the protocol used by the XMLSocket class. The protocol is
- described in the following list:
- * XML messages are sent over a full-duplex TCP/IP stream socket
- connection.
+ The XMLSocket class implements client sockets that let the OpenFL
+ application communicate with a server computer identified by an IP address
+ or domain name. The XMLSocket class is useful for client-server applications
+ that require low latency, such as real-time chat systems. A traditional
+ HTTP-based chat solution frequently polls the server and downloads new
+ messages using an HTTP request. In contrast, an XMLSocket chat solution
+ maintains an open connection to the server, which lets the server
+ immediately send incoming messages without a request from the client. To use
+ the XMLSocket class, the server computer must run a daemon that understands
+ the protocol used by the XMLSocket class. The protocol is described in the
+ following list:
+
+ * XML messages are sent over a full-duplex TCP/IP stream socket connection.
* Each XML message is a complete XML document, terminated by a zero (0)
byte.
* An unlimited number of XML messages can be sent and received over a
diff --git a/src/openfl/sensors/Accelerometer.hx b/src/openfl/sensors/Accelerometer.hx
index 073e515d19..5d3687a1c6 100644
--- a/src/openfl/sensors/Accelerometer.hx
+++ b/src/openfl/sensors/Accelerometer.hx
@@ -30,6 +30,11 @@ import lime.system.SensorType;
`Accelerometer.isSupported` is `true` at runtime,
then Accelerometer support currently exists.
+ _OpenFL target support:_ This feature is supported on mobile targets,
+ including iOS and Android, and on the html5 target in browsers that
+ support the devicemotion event. This feature is not supported on desktop
+ targets.
+
_Adobe AIR profile support:_ This feature is supported only on mobile
devices. It is not supported on desktop or AIR for TV devices. See
[AIR Profile Support](http://help.adobe.com/en_US/air/build/WS144092a96ffef7cc16ddeea2126bb46b82f-8000.html)
diff --git a/src/openfl/system/Capabilities.hx b/src/openfl/system/Capabilities.hx
index 21313d5432..67e83dff6c 100644
--- a/src/openfl/system/Capabilities.hx
+++ b/src/openfl/system/Capabilities.hx
@@ -260,8 +260,8 @@ import sys.io.Process;
| Turkish | `tr` |
_Note:_ The value of `Capabilities.language` property is limited to
- the possible values on this list. Because of this limitation, Adobe
- AIR applications should use the first element in the
+ the possible values on this list. Because of this limitation, OpenFL
+ applications should use the first element in the
`Capabilities.languages` array to determine the primary user interface
language for the system.
@@ -292,12 +292,12 @@ import sys.io.Process;
public static var localFileReadDisable(default, null) = #if web true #else false #end;
/**
- Specifies the manufacturer of the running version of Flash Player or the
- AIR runtime, in the format `"Adobe`
- `_OSName_"`. The value for `_OSName_`
- could be `"Windows"`, `"Macintosh"`,
- `"Linux"`, or another operating system name. The server string
- is `M`.
+ Specifies the manufacturer of the running version of OpenFL, in the
+ format "_ManufacturerName_ _OSName_". The value for `_ManufacturerName_`
+ is typically "OpenFL". When targeting Adobe Flash Player or AIR, the
+ value for `_ManufacturerName_` is "Adobe". The value for `_OSName_`
+ could be `"Windows"`, `"Macintosh"`, `"Linux"`, or another operating
+ system name. The server string is `M`.
Do _not_ use `Capabilities.manufacturer` to determine a
capability based on the operating system if a more specific capability
@@ -374,12 +374,12 @@ import sys.io.Process;
* `"ActiveX"` for the Flash Player ActiveX control used by
Microsoft Internet Explorer
- * `"Desktop"` for the Adobe AIR runtime(except for SWF
+ * `"Desktop"` for the Adobe AIR runtime (except for SWF
content loaded by an HTML page, which has
`Capabilities.playerType` set to `"PlugIn"`)
* `"External"` for the external Flash Player or in test mode
- * `"PlugIn"` for the Flash Player browser plug-in(and for
+ * `"PlugIn"` for the Flash Player browser plug-in (and for
SWF content loaded by an HTML page in an AIR application)
* `"StandAlone"` for the stand-alone Flash Player
@@ -403,27 +403,25 @@ import sys.io.Process;
/**
Specifies the maximum horizontal resolution of the screen. The server
- string is `R`(which returns both the width and height of the
- screen). This property does not update with a user's screen resolution and
- instead only indicates the resolution at the time Flash Player or an Adobe
- AIR application started. Also, the value only specifies the primary
- screen.
+ string is `R` (which returns both the width and height of the screen).
+ This property does not update with a user's screen resolution and
+ instead only indicates the resolution at the time the OpenFL application
+ started. Also, the value only specifies the primary screen.
**/
public static var screenResolutionX(get, never):Float;
/**
- Specifies the maximum vertical resolution of the screen. The server string
- is `R`(which returns both the width and height of the screen).
- This property does not update with a user's screen resolution and instead
- only indicates the resolution at the time Flash Player or an Adobe AIR
- application started. Also, the value only specifies the primary screen.
+ Specifies the maximum vertical resolution of the screen. The server
+ string is `R` (which returns both the width and height of the screen).
+ This property does not update with a user's screen resolution and
+ instead only indicates the resolution at the time the OpenFL application
+ started. Also, the value only specifies the primary screen.
**/
public static var screenResolutionY(get, never):Float;
/**
A URL-encoded string that specifies values for each Capabilities property.
-
The following example shows a URL-encoded string:
`A=t&SA=t&SV=t&EV=t&MP3=t&AE=t&VE=t&ACC=f&PR=t&SP=t&
SB=f&DEB=t&V=WIN%208%2C5%2C0%2C208&M=Adobe%20Windows&
diff --git a/src/openfl/system/Security.hx b/src/openfl/system/Security.hx
index 5ee0b8ae2f..6a3de7b8fa 100644
--- a/src/openfl/system/Security.hx
+++ b/src/openfl/system/Security.hx
@@ -92,9 +92,9 @@ class Security
later, set `Security.exactSettings` to `false` before calling
`SharedObject.getLocal()`.
- @throws SecurityError A Flash Player or AIR application already used
- the value of `exactSettings` at least once in a
- decision about player settings.
+ @throws SecurityError An OpenFL application already used the value of
+ `exactSettings` at least once in a decision about
+ player settings.
**/
public static var exactSettings:Bool;
@@ -144,6 +144,7 @@ class Security
/**
Lets SWF files in the identified domains access objects and variables
in the SWF file that contains the `allowDomain()` call.
+
_Note:_ Calling this method from code in the AIR application sandbox
throws a SecurityError exception. Content outside of the application
security domain cannot directly cross-script content in the
diff --git a/src/openfl/system/System.hx b/src/openfl/system/System.hx
index ffa1ec431a..7816a1b603 100644
--- a/src/openfl/system/System.hx
+++ b/src/openfl/system/System.hx
@@ -42,7 +42,6 @@ import hl.Gc;
**/
// @:noCompletion @:dox(hide) @:require(flash10_1) public static var freeMemory (default, null):Float;
#end
-
#if false
/**
The currently installed system IME. To register for imeComposition
@@ -50,7 +49,6 @@ import hl.Gc;
**/
// @:noCompletion @:dox(hide) public static var ime (default, null):openfl.system.IME;
#end
-
#if false
/**
The entire amount of memory (in bytes) used by an application. This is
@@ -69,8 +67,8 @@ import hl.Gc;
The amount of memory(in bytes) currently in use that has been directly
allocated by Flash Player or AIR.
- This property does not return _all_ memory used by an Adobe AIR
- application or by the application(such as a browser) containing Flash
+ This property does not return _all_ memory used by an OpenFL
+ application or by the application (such as a browser) containing Flash
Player content. The browser or operating system may consume other memory.
The `System.privateMemory` property reflects _all_ memory
used by an application.
@@ -87,13 +85,13 @@ import hl.Gc;
/**
A Boolean value that determines which code page to use to interpret
external text files. When the property is set to `false`,
- external text files are interpretted as Unicode.(These files must be
+ external text files are interpretted as Unicode. (These files must be
encoded as Unicode when you save them.) When the property is set to
`true`, external text files are interpretted using the
traditional code page of the operating system running the application. The
default value of `useCodePage` is `false`.
- Text that you load as an external file(using
+ Text that you load as an external file (using
`Loader.load()`, the URLLoader class or URLStream) must have
been saved as Unicode in order for the application to recognize it as
Unicode. To encode external files as Unicode, save the files in an
@@ -171,8 +169,9 @@ import hl.Gc;
_For the standalone Flash Player debugger version only._
- AIR applications should call the `NativeApplication.exit()`
- method to exit the application.
+ OpenFL applications on desktop operating systems should call the
+ `NativeApplication.exit()` method to exit the application. It is not
+ recommended to manually exit an application on mobile operating systems.
@param code A value to pass to the operating system. Typically, if the
process exits normally, the value is 0.
@@ -187,11 +186,16 @@ import hl.Gc;
/**
Forces the garbage collection process.
- _For the Flash Player debugger version and AIR applications only._
+ _OpenFL target support:_ This feature is supported on all desktop
+ operating systems, on iOS, and on Android. This feature is not supported
+ on the html5 target.
+
+ For Adobe Flash Player, the `System.gc()` method is only enabled in
+ the debugger version of the runtime.
+
In an AIR application, the `System.gc()` method is only enabled
- in content running in the AIR Debug Launcher(ADL) or, in an installed
+ in content running in the AIR Debug Launcher (ADL) or, in an installed
application, in content in the application security sandbox.
-
**/
public static function gc():Void
{
@@ -242,9 +246,9 @@ import hl.Gc;
This method is provided for SWF content running in Flash Player 9. It
allows only adding String content to the Clipboard.
- Flash Player 10 content and content in the application security sandbox
- in an AIR application can call the `Clipboard.setData()`
- method.
+ Flash Player 10 content, content in the application security sandbox
+ in an AIR application, and Haxe "sys" targets can call the
+ `Clipboard.setData()` method.
@param string A plain-text string of characters to put on the system
Clipboard, replacing its current contents(if any).
diff --git a/src/openfl/text/StageText.hx b/src/openfl/text/StageText.hx
index 2360d0c941..8f1f8bf66d 100644
--- a/src/openfl/text/StageText.hx
+++ b/src/openfl/text/StageText.hx
@@ -37,7 +37,7 @@ import openfl.text.engine.FontWeight;
_you cannot use embedded fonts._
_OpenFL target support:_ On all platforms, except AIR, StageText uses the
- runtime TextField.
+ runtime TextField fallback.
_Adobe AIR profile support:_ This feature is supported on iOS and Android
platforms. StageText uses native text input fields on Android and iOS mobile