Adobe® AIR® API Reference for HTML Developers
Home  |  Show Classes List |  Index  |  Appendixes

Language Reference only       
NativeWindow 
3D:
Context3D
Context3DBlendFactor
Context3DClearMask
Context3DCompareMode
Context3DProgramType
Context3DRenderMode
Context3DStencilAction
Context3DTextureFormat
Context3DTriangleFace
Context3DVertexBufferFormat
CubeTexture
IndexBuffer3D
Program3D
Stage3D
Texture
VertexBuffer3D
Air.net:
ServiceMonitor
SocketMonitor
URLMonitor
Air.update:
ApplicationUpdater
ApplicationUpdaterUI
DownloadErrorEvent
StatusFileUpdateErrorEvent
StatusFileUpdateEvent
StatusUpdateErrorEvent
StatusUpdateEvent
UpdateEvent
Data:
EncryptedLocalStore
SQLCollationType
SQLColumnNameStyle
SQLColumnSchema
SQLConnection
SQLError
SQLErrorEvent
SQLErrorOperation
SQLEvent
SQLIndexSchema
SQLMode
SQLResult
SQLSchema
SQLSchemaResult
SQLStatement
SQLTableSchema
SQLTransactionLockType
SQLTriggerSchema
SQLUpdateEvent
SQLViewSchema
Desktop:
Clipboard
ClipboardFormats
ClipboardTransferMode
DockIcon
Icon
InteractiveIcon
NativeApplication
NativeProcess
NativeProcessStartupInfo
NotificationType
SystemTrayIcon
Display:
BitmapData
NativeMenu
NativeMenuItem
Screen
Stage
StageDisplayState
StageQuality
Events:
ActivityEvent
AsyncErrorEvent
BrowserInvokeEvent
DataEvent
DatagramSocketDataEvent
DNSResolverEvent
DRMAuthenticateEvent
DRMStatusEvent
ErrorEvent
Event
EventDispatcher
FileListEvent
HTTPStatusEvent
InvokeEvent
InvokeEventReason
IOErrorEvent
LocationChangeEvent
MouseEvent
NativeProcessExitEvent
NetDataEvent
NetMonitorEvent
NetStatusEvent
OutputProgressEvent
ProgressEvent
SampleDataEvent
SecurityErrorEvent
ServerSocketConnectEvent
StatusEvent
StorageVolumeChangeEvent
TimerEvent
UncaughtErrorEvent
UncaughtErrorEvents
File:
File
FileMode
FileStream
StorageVolume
StorageVolumeInfo
Functions:
trace()
generateRandomBytes()
navigateToURL()
sendToURL()
Geom:
Matrix
Point
Rectangle
Media:
AudioDecoder
AudioPlaybackMode
H264Level
H264Profile
H264VideoStreamSettings
ID3Info
InputMediaStream
Microphone
MicrophoneEnhancedMode
MicrophoneEnhancedOptions
Sound
SoundChannel
SoundCodec
SoundLoaderContext
SoundMixer
SoundTransform
VideoCodec
VideoStatus
VideoStreamSettings
Native window:
NativeWindow
NativeWindowBoundsEvent
NativeWindowDisplayState
NativeWindowDisplayStateEvent
NativeWindowInitOptions
NativeWindowRenderMode
NativeWindowResize
NativeWindowSystemChrome
NativeWindowType
Net:
AAAARecord
ARecord
CertificateStatus
DatagramSocket
DNSResolver
FileFilter
InterfaceAddress
IPVersion
LocalConnection
MXRecord
NetConnection
NetMonitor
NetStreamAppendBytesAction
NetStreamMulticastInfo
NetworkInfo
NetworkInterface
ObjectEncoding
PTRRecord
ResourceRecord
Responder
SecureSocket
ServerSocket
SharedObject
SharedObjectFlushStatus
Socket
SRVRecord
URLLoader
URLLoaderDataFormat
URLRequest
URLRequestDefaults
URLRequestHeader
URLRequestMethod
URLStream
URLVariables
XMLSocket
Security:
ReferencesValidationSetting
RevocationCheckSettings
SignatureStatus
SignerTrustSettings
X500DistinguishedName
X509Certificate
XMLSignatureValidator
System:
Capabilities
Security
System
Updater
Ui:
Keyboard
KeyboardType
KeyLocation
Mouse
MouseCursorData
Utils:
Vector
ByteArray
Collator
CollatorMode
CompressionAlgorithm
CurrencyFormatter
CurrencyParseResult
DateTimeFormatter
DateTimeNameContext
DateTimeNameStyle
DateTimeStyle
Endian
HTMLLoader
HTMLPDFCapability
LastOperationStatus
LocaleID
NationalDigitsType
NumberFormatter
NumberParseResult
StringTools
Timer
window.runtime propertywindow.runtime.flash.display.NativeWindow
InheritanceNativeWindow Inheritance EventDispatcher Inheritance Object

Runtime Versions:  1.0

The NativeWindow class provides an interface for creating and controlling native desktop windows.

A reference to the NativeWindow instance is returned by the window constructor. JavaScript in an HTML page can reference the NativeWindow instance by using the window.nativeWindow property.

The properties of a NativeWindow instance can only be accessed by application content. If non-application content attempts to access the NativeWindow object, a security error will be thrown.

Content can be added to a window using the DisplayObjectContainer methods of the Stage object such as addChild().

To create a root HTML window for displaying HTML content it is typically easier to create the window with HTMLLoader.createRootWindow(). Windows created in this way will have an HTMLLoader object added automatically. (From JavaScript code, you can also use the JavaScript window.open() function. However, this method gives you less control over the window appearance and behavior.)

The following operations on NativeWindow objects are asynchronous: close(), maximize(), minimize(), restore(), and bounds changes. An application can detect when these operations have completed by listening for the appropriate events.

If the NativeApplication.autoExit property is true, which is the default, the application will close when its last window is closed (and all close event handlers have returned). If autoExit is false, then NativeApplication.nativeApplication.exit() must be called to terminate the application.

NativeWindow objects will not be garbage collected after the window constructor has been called and before close() has been called. It is the responsibility of the application to close its own windows.

See also



Properties
 PropertyDefined By
  active : Boolean
[read-only] Indicates whether this window is the active application window.
NativeWindow
  alwaysInFront : Boolean
Specifies whether this window will always be in front of other windows (including those of other applications).
NativeWindow
  bounds : Rectangle
The size and location of this window.
NativeWindow
  closed : Boolean
[read-only] Indicates whether this window has been closed.
NativeWindow
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  displayState : String
[read-only] The display state of this window.
NativeWindow
  height : Number
The height of this window in pixels.
NativeWindow
  isSupported : Boolean
[static] [read-only] Indicates whether native windows are supported on the client system.
NativeWindow
  maximizable : Boolean
[read-only] Reports the maximizable setting used to create this window.
NativeWindow
  maxSize : Point
The maximum size for this window.
NativeWindow
  menu : NativeMenu
The native menu for this window.
NativeWindow
  minimizable : Boolean
[read-only] Reports the minimizable setting used to create this window.
NativeWindow
  minSize : Point
The minimum size for this window.
NativeWindow
  owner : NativeWindow
[read-only] The NativeWindow object that owns this window.
NativeWindow
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  renderMode : String
[read-only] Reports the window renderMode setting used to create this window.
NativeWindow
  resizable : Boolean
[read-only] Reports the resizable setting used to create this window.
NativeWindow
  stage : Stage
[read-only] The Stage object for this window.
NativeWindow
  supportsMenu : Boolean
[static] [read-only] Indicates whether AIR supports native window menus on the current computer system.
NativeWindow
  supportsNotification : Boolean
[static] [read-only] Indicates whether AIR supports window notification cueing on the current computer system.
NativeWindow
  supportsTransparency : Boolean
[static] [read-only] Indicates whether AIR supports native windows with transparent pixels.
NativeWindow
  systemChrome : String
[read-only] Reports the system chrome setting used to create this window.
NativeWindow
  systemMaxSize : Point
[static] [read-only] The largest window size allowed by the operating system.
NativeWindow
  systemMinSize : Point
[static] [read-only] The smallest window size allowed by the operating system.
NativeWindow
  title : String
The window title.
NativeWindow
  transparent : Boolean
[read-only] Reports the transparency setting used to create this window.
NativeWindow
  type : String
[read-only] Reports the window type setting used to create this window.
NativeWindow
  visible : Boolean
Specifies whether this window is visible.
NativeWindow
  width : Number
The width of this window in pixels.
NativeWindow
  x : Number
The horizontal axis coordinate of this window's top left corner relative to the origin of the operating system desktop.
NativeWindow
  y : Number
The vertical axis coordinate of this window's top left corner relative to the upper left corner of the operating system's desktop.
NativeWindow
Public Methods
 MethodDefined By
  
Creates a new NativeWindow instance and a corresponding operating system window.
NativeWindow
  
activate():void
Activates this window.
NativeWindow
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
  
close():void
Closes this window.
NativeWindow
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
  
Converts a point in pixel coordinates relative to the origin of the window stage (a global point in terms of the display list), to a point on the virtual desktop.
NativeWindow
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
  
listOwnedWindows():Vector.<NativeWindow>
Returns a list of the NativeWindow objects that are owned by this window.
NativeWindow
  
maximize():void
Maximizes this window.
NativeWindow
  
minimize():void
Minimizes this window.
NativeWindow
  
notifyUser(type:String):void
Triggers a visual cue through the operating system that an event of interest has occurred.
NativeWindow
  
orderInBackOf(window:NativeWindow):Boolean
Sends this window directly behind the specified window.
NativeWindow
  
Brings this window directly in front of the specified window.
NativeWindow
  
orderToBack():Boolean
Sends this window behind any other visible windows.
NativeWindow
  
orderToFront():Boolean
Brings this window in front of any other visible windows.
NativeWindow
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
  
restore():void
Restores this window from either a minimized or a maximized state.
NativeWindow
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
  
startMove():Boolean
Starts a system-controlled move of this window.
NativeWindow
  
startResize(edgeOrCorner:String = "BR"):Boolean
Starts a system-controlled resize operation of this window.
NativeWindow
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
  Dispatched by this NativeWindow object after the window has been activated.NativeWindow
  Dispatched by this NativeWindow object after the window has been closed.NativeWindow
  Dispatched by this NativeWindow object immediately before the window is to be closed.NativeWindow
  Dispatched by this NativeWindow object after the window has been deactivated.NativeWindow
  Dispatched by this NativeWindow object after the window's displayState property has changed.NativeWindow
  Dispatched by this NativeWindow object immediately before the window changes its display state.NativeWindow
  Dispatched by this NativeWindow object after the window has been moved on the desktop.NativeWindow
  Dispatched by the NativeWindow object immediately before the window is to be moved on the desktop.NativeWindow
  Dispatched by this NativeWindow object after the window has been resized.NativeWindow
  Dispatched by this NativeWindow object immediately before the window is to be resized on the desktop.NativeWindow
Property Detail

active

property
active:Boolean  [read-only]

Runtime Versions:  1.0

Indicates whether this window is the active application window.

Use the activate() method to make a window active.

See also

alwaysInFront

property 
alwaysInFront:Boolean

Runtime Versions:  1.0

Specifies whether this window will always be in front of other windows (including those of other applications).

There are two groups of windows in the system depth order. Windows in the alwaysInFront group are always displayed in front of all other windows. Depth ordering between windows within the same group is determined normally. In other words, activating a window will bring it in front of other windows in its group.

Changing alwaysInFront from false to true will bring the window to the top of all other windows. Changing the property from true to false will send the window to the back of "alwaysInFront" windows, but still in front of other windows. Setting the property to its current value will not change the window depth order. Setting the alwaysInFront property of a window that has an owner has no effect.

The alwaysInFront property should rarely be set to true since windows with this setting will appear in front of the windows of other applications even when the other application is active.

OS behavior notes:

  • Some Linux window managers do not display windows that have the alwaysInFront property set to in front of fullscreen windows.
  • On Mac® OS X, setting alwaysInFront to true will have no effect when the displayState property of the window stage is fullScreen or fullScreenInteractive.


Example  ( How to use this example )
Keep a window in front of other windows:
window.nativeWindow.alwaysInFront = true;
Keep a window in front of other windows:
window.nativeWindow.alwaysInFront = true;

bounds

property 
bounds:Rectangle

Runtime Versions:  1.0

The size and location of this window.

The dimensions of a window include any system chrome. The dimensions of a window's stage are equal to the dimensions of the window, minus the size of any system chrome. Changing the width and height of the window will change the stage's stageWidth and stageHeight. The reverse also applies; changing the stage dimensions will change the window size.

In a root HTML window, the outerWidth and outerHeight properties are equivalent to the window height and width properties. The innerWidth and innerHeight properties equal the stage.stageWidth and stage.stageHeight properties minus the thickness of any automatic scrollbars displayed by the window.

A resize event is dispatched whenever the width or height of this window changes. Likewise, a move event is dispatched whenever the origin (x,y) of this window changes. On Mac OS and Windows, setting the bounds property directly will not dispatch a moving or resizing event. However, on Linux the NativeWindow does dispatch a moving and resizing events when you set the bounds property.

Setting the bounds property of a window is equivalent to setting its x, y, width, and height properties. Likewise, setting any of the individual dimensions is equivalent to setting the bounds property. When you set all the dimensions at the same time by using the bounds property, fewer events are dispatched.

The order in which the individual dimensions are set is not guaranteed. On Linux window managers that do not allow windows to extend off the desktop area, a change to an individual property may be blocked even though the net affect of applying all the property changes would have resulted in a legal window.

If the width or height specified is less than the minimum or greater than the maximum allowed width or height, then the window width or height is set to the closest legal size. The factors that determine the minimum and maximum width and height are the following:

  • The minSize and maxSize properties of the NativeWindow object
  • The minimum and maximum operating system limits, which are the values of NativeWindow.systemMinSize and NativeWindow.systemMaxSize.
  • The maximum width and height of a window in Adobe AIR, which are each 4095 pixels. (In AIR 1.5 and earlier, the maximum width and height of a window is 2880 pixels each.)
  • The minimum width and height required by any displayed system chrome.

Pixel values are rounded to the nearest integer when the position or dimensions of a window are changed.


Throws
ArgumentError — If the rectangle is null or contains invalid values.
 
IllegalOperationError — If the bounds property is accessed after this window has been closed.

See also


Example  ( How to use this example )
Set the location and size of the native desktop window:
window.nativeWindow.bounds = new air.Rectangle( 20, 20, 800, 600 );
Set the location and size of the native desktop window:
window.nativeWindow.bounds = new air.Rectangle( 20, 20, 800, 600 );

closed

property 
closed:Boolean  [read-only]

Runtime Versions:  1.0

Indicates whether this window has been closed.

Accessing the following properties on a closed window will throw an illegal operation error:

  • title
  • bounds
  • x, y, width, height
  • displayState
  • visible

Likewise, calling the following methods on a closed window will also throw an illegal operation error:

  • minimize()
  • maximize()
  • restore()
  • startResize()
  • startMove()

displayState

property 
displayState:String  [read-only]

Runtime Versions:  1.0

The display state of this window.

Constants for the possible values are defined in the NativeWindowDisplayState class:

  • NativeWindowDisplayState.NORMAL
  • NativeWindowDisplayState.MINIMIZED
  • NativeWindowDisplayState.MAXIMIZED


Throws
IllegalOperationError — If the displayState property is accessed after this window has been closed.

See also

height

property 
height:Number

Runtime Versions:  1.0

The height of this window in pixels.

The dimensions of a window include any system window chrome that is displayed. The height of the usable display area inside a window is available from the Stage.stageHeight property.

Changing the height property of a window is equivalent to changing the height through the bounds property.

If the height specified is less than the minimum or greater than the maximum allowed height, then the window height is set to the closest legal size. The factors that determine the minimum and maximum height are the following:

  • The minSize.x and maxSize.x properties of the NativeWindow object
  • The minimum and maximum operating system limits, which are the values of NativeWindow.systemMinSize.x and NativeWindow.systemMaxSize.x.
  • The maximum height of a window in Adobe AIR, which is 4095 pixels (2880 pixels in AIR 1.5 and earlier).

On Linux, setting the height property is an asynchronous operation.

To detect the completion of the height change, listen for the resize event, which is dispatched on all platforms.

Pixel values are rounded to the nearest integer when the height of a window is changed.


Throws
ArgumentError — If the value set is null or invalid.
 
IllegalOperationError — If the property is accessed after this window has been closed.

See also

isSupported

property 
isSupported:Boolean  [read-only]

Runtime Versions:  2.0

Indicates whether native windows are supported on the client system.

maximizable

property 
maximizable:Boolean  [read-only]

Runtime Versions:  1.0

Reports the maximizable setting used to create this window.

The maximizable setting cannot be changed after a window is created.

Note: Some Linux window managers allow windows to be maximized by the user even when the maximizable property is set to false.


Throws
SecurityError — When trying to set to false without sufficient privilege.
 
IllegalOperationError — If the property is accessed after this window has been closed.

See also

maxSize

property 
maxSize:Point

Runtime Versions:  1.0

The maximum size for this window.

The size limit is specified as the coordinates of a Point object. The point x property corresponds to the window width, the y property to the window height.

The maxSize restriction is enforced for window resizing operations invoked both through JavaScript code and through the operating system.

Setting maxSize will change the window bounds if the current bounds are larger than the new maximum size.

If the width or height specified is greater than the maximum allowed width or height, then the window width is set to the closest legal size. The factors that determine the minimum and maximum width and height are the following:

  • The maximum operating system limit, which is the value NativeWindow.systemMaxSize.
  • The maximum width and height of a window in Adobe AIR, which is 4095 pixels for each. (In AIR 1.5 and earlier, the maximum width and height of a window is 2880 pixels each.)

Note: On some operating systems, such as Mac OS X, maximizing a window will only enlarge the window to the maxSize value even if the maximized window will be smaller than the operating system screen. The window will still be in the maximized display state.


Throws
IllegalOperationError — If assigned size is not within the operating system minimum and maximum window sizes.
 
SecurityError — If size is forbidden for the content's current privilege.
 
ArgumentError — If the size is null or contains invalid values.
 
IllegalOperationError — If the maxSize property is accessed after this window has been closed.

See also


Example  ( How to use this example )
Set the maximum window size:
window.nativeWindow.maxSize = new air.Point(960, 960);
Set the maximum window size:
window.nativeWindow.maxSize = new air.Point(960, 960);

menu

property 
menu:NativeMenu

Runtime Versions:  1.0

The native menu for this window.

When a NativeMenu object is assigned to the window menu property, a native menu will be displayed for a window if NativeWindow.supportsMenu is true, unless the window systemChrome property is NativeWindowSystemChrome.NONE.

Note: Assigning a menu to a window when NativeWindow.supportsMenu is false or when the window systemChrome property is NativeWindowSystemChrome.NONE is allowed, but does nothing. Be sure to use the NativeWindow.supportsMenu property to determine whether the operating system supports window menus. Using other means (such as Capabilities.os) to determine support can lead to programming errors (if some possible target operating systems are not considered).

See also

minimizable

property 
minimizable:Boolean  [read-only]

Runtime Versions:  1.0

Reports the minimizable setting used to create this window.

The minimizable setting cannot be changed after a window is created.

Note: Some Linux window managers allow windows to be minimizable by the user even when the minimizable property is set to false.


Throws
SecurityError — When trying to set to false without sufficient privilege.
 
IllegalOperationError — If the property is accessed after this window has been closed.

See also

minSize

property 
minSize:Point

Runtime Versions:  1.0

The minimum size for this window.

The size limit is specified as the coordinates of a Point object. The point x property corresponds to the window width, the y property to the window height.

Setting minSize, will change the window bounds if the current bounds are smaller than the new minimum size.

The minSize restriction is enforced for window resizing operations invoked both through JavaScript code and through the operating system.

Note: The width and height of any displayed system chrome may make it impossible to set a window as small as the specified minimum size.


Throws
IllegalOperationError — If the assigned size is not within the operating system minimum and maximum window sizes.
 
SecurityError — If size is forbidden for the content's current privilege.
 
ArgumentError — If the size is null or contains invalid values.
 
IllegalOperationError — if the minSize property is accessed after this window has been closed.

See also


Example  ( How to use this example )
Set the minimum size for a window:
window.nativeWindow.minSize = new air.Point(80, 60);
Set the minimum size for a window:
window.nativeWindow.minSize = new air.Point(80, 60);

owner

property 
owner:NativeWindow  [read-only]

Runtime Versions:  2.6

The NativeWindow object that owns this window.

Window ownership is established when a window is created and cannot be changed. To create a window that has an owner, set the owning NativeWindow object as the owner property of the NativeWindowInitOptions object used to create the owned window.

Note: On Linux, some window managers do not display owned windows in front of the owning window when the owner is in fullscreen mode.

See also

renderMode

property 
renderMode:String  [read-only]

Runtime Versions:  3.0

Reports the window renderMode setting used to create this window.

The value returned by NativeWindow.renderMode will be one of the constants defined in the NativeWindowRenderMode class.

The renderMode setting cannot be changed after a window is created.


Throws
IllegalOperationError — If the property is accessed after this window has been closed.

See also

resizable

property 
resizable:Boolean  [read-only]

Runtime Versions:  1.0

Reports the resizable setting used to create this window.

The resizable setting cannot be changed after a window is created.


Throws
SecurityError — When trying to set to false without sufficient privilege.
 
IllegalOperationError — If the property is accessed after this window has been closed.

See also

stage

property 
stage:Stage  [read-only]

Runtime Versions:  1.0

The Stage object for this window.

The stage is the root of the display list for the window. Add visual display objects to a window by adding them to the stage or to another object already in the display list of this stage. The stage dimensions are those of the window client area when the window uses system chrome. The stage dimensions are equal to the dimensions of the window if system chrome is not used.

The HTMLLoader, which renders HTML content, is a single leaf in the display list tree. ActionScript-defined display objects can be both above and below the HTMLLoader in the drawing order, but not in between the visual elements rendered by the HTMLLoader.

See also

supportsMenu

property 
supportsMenu:Boolean  [read-only]

Runtime Versions:  1.0

Indicates whether AIR supports native window menus on the current computer system.

When NativeWindow.supportsMenu is true, a native menu will be displayed for a window when a NativeMenu object is assigned to the window menu property (unless the window systemChrome property is NativeWindowSystemChrome.NONE). Be sure to use the NativeWindow.supportsMenu property to determine whether the operating system native window menus. Using other means (such as Capabilities.os) to determine support can lead to programming errors (if some possible target operating systems are not considered).

Note: Assigning a menu to a window when NativeWindow.supportsMenu is false or when the window systemChrome property is NativeWindowSystemChrome.NONE is allowed, but does nothing.

See also

supportsNotification

property 
supportsNotification:Boolean  [read-only]

Runtime Versions:  1.0

Indicates whether AIR supports window notification cueing on the current computer system.

When NativeWindow.supportsNotification is true, calling the window's notifyUser() method will result in a visual cue to the user that an event of interest has occurred. This visual cue will conform to the operating system convention of the native system. For example, on Windows®, the task bar icon will flash.

Note: Calling notifyUser() when NativeWindow.supportsNotification is false is allowed, but does nothing.

See also

supportsTransparency

property 
supportsTransparency:Boolean  [read-only]

Runtime Versions:  1.1

Indicates whether AIR supports native windows with transparent pixels.

When NativeWindow.supportsTransparency is true, transparency in pixels of a native window will be honored, if the window transparent property is set to true. Opacity of all pixels will be set to 1 if NativeWindow.supportsTransparency is false, regardless of the value of the window transparent property. Fully transparent pixels will render as black when NativeWindow.supportsTransparency is false. Be sure to use the NativeWindow.supportsTransparency property to determine whether the operating system supports transparency. Using other means (such as Capabilities.os) to determine support can lead to programming errors (if some possible target operating systems are not considered).

Note: The value of this property might change while an application is running, based on user preferences set for the operating system.

See also

systemChrome

property 
systemChrome:String  [read-only]

Runtime Versions:  1.0

Reports the system chrome setting used to create this window.

The values returned by NativeWindow.systemChrome will be one of the constants defined in the NativeWindowSystemChrome class.

The system chrome setting cannot be changed after a window is created.


Throws
SecurityError — When trying to set to false without sufficient privilege.
 
IllegalOperationError — If the property is accessed after this window has been closed.

See also


Example  ( How to use this example )
Check the type of system chrome used by a window:
var sysChromeType = window.nativeWindow.systemChrome;
Check the type of system chrome used by a window:
var sysChromeType = window.nativeWindow.systemChrome;

systemMaxSize

property 
systemMaxSize:Point  [read-only]

Runtime Versions:  1.0

The largest window size allowed by the operating system.

The size limit is specified as the coordinates of a Point object. The point x property corresponds to the window width, the y property to the window height.

In addition to the operating system size limit, AIR has a maximum window size limit of 4095 by 4095 pixels (2880 pixels by 2880 pixels in AIR 1.5 and earlier). And an application can set a limit using the maxSize property of the NativeWindow object.

systemMinSize

property 
systemMinSize:Point  [read-only]

Runtime Versions:  1.0

The smallest window size allowed by the operating system.

The size limit is specified as the coordinates of a Point object. The point x property corresponds to the window width, the y property to the window height.

title

property 
title:String

Runtime Versions:  1.0

The window title.

The title will appear in the system chrome for the window, if displayed, as well as in other system-dependent locations (such as the task bar).


Throws
IllegalOperationError — If the property is accessed after this window has been closed.

transparent

property 
transparent:Boolean  [read-only]

Runtime Versions:  1.0

Reports the transparency setting used to create this window.

The transparent property cannot be changed after a window is created. Transparency affects both the visual appearance and the mouse behavior of the window. On Windows and Mac OS X, the window will not capture mouse events when the alpha value of the pixel is below a certain threshold, which varies between about .06 and .01 depending on the operating system. On Linux, the the window will capture mouse events above completely transparent areas and therefore will prevent users from accessing other windows and items on the desktop.

Note: Window transparency cannot always be supported. If the user's operating system configuration is such that transparency is not available, the window will be created without transparency. Areas that would have been transparent are composited against black. Use the NativeWindow.supportsTransparency property to determine whether window transparency is supported.


Throws
SecurityError — When trying to set to false without sufficient privilege.
 
IllegalOperationError — If the property is accessed after this window has been closed.

See also

type

property 
type:String  [read-only]

Runtime Versions:  1.0

Reports the window type setting used to create this window.

The values returned by NativeWindow.type will be one of the constants defined in the NativeWindowType class.

The type setting cannot be changed after a window is created.


Throws
SecurityError — When trying to set to false without sufficient privilege.
 
IllegalOperationError — If the property is accessed after this window has been closed.

See also

visible

property 
visible:Boolean

Runtime Versions:  1.0

Specifies whether this window is visible.

An invisible window is not displayed on the desktop, but all window properties and methods are valid.

By default, visible is set to false. To display a window, set visible to true or call NativeWindow.activate().

If this window has an owner, the visible state of that owning window determines whether this window is displayed. If the owning window is not displayed, then any owned windows are not displayed, even if their visible properties are true.

Note: On Mac OS X, setting visible=false on a minimized window will not remove the window icon from the dock. If a user subsequently clicks the dock icon, the window will return to the visible state and be displayed on the desktop.


Throws
SecurityError — When trying to set to false without sufficient privilege.
 
IllegalOperationError — If the property is accessed after this window has been closed.

See also


Example  ( How to use this example )
Make a window visible:
window.nativeWindow.visible = true;
Make a window visible:
window.nativeWindow.visible = true;

width

property 
width:Number

Runtime Versions:  1.0

The width of this window in pixels.

The dimensions reported for a native window include any system window chrome that is displayed. The width of the usable display area inside a window is available from the Stage.stageWidth property.

Changing the width property of a window is equivalent to changing the width through the bounds property.

If the width specified is less than the minimum or greater than the maximum allowed width, then the window width is set to the closest legal size. The factors that determine the minimum and maximum width are the following:

  • The minSize.y and maxSize.y properties of the NativeWindow object
  • The minimum and maximum operating system limits, which are the values of NativeWindow.systemMinSize.y and NativeWindow.systemMaxSize.y.
  • The maximum width of a window in Adobe AIR, which is 4095 pixels (2880 pixels in AIR 1.5 and earlier).

On Linux, setting the width property is an asynchronous operation.

To detect the completion of the width change, listen for the resize event, which is dispatched on all platforms.

Pixel values are rounded to the nearest integer when the width of a window is changed.


Throws
ArgumentError — If the value set is null or invalid.
 
IllegalOperationError — If the property is accessed after this window has been closed.

See also

x

property 
x:Number

Runtime Versions:  1.0

The horizontal axis coordinate of this window's top left corner relative to the origin of the operating system desktop.

On systems with more than one monitor, x can be negative. If you save the value, perhaps to reposition a window at its previous location, you should always verify that the window is placed in a usable location when the position is restored. Changes in screen resolution or monitor arrangement can can result in a window being placed off screen. Use the Screen class to obtain information about the desktop geometry.

Changing the x property of a window is equivalent to changing the location through the bounds property.

On Linux, setting the x property is an asynchronous operation.

To detect the completion of the position change, listen for the move event, which is dispatched on all platforms.

Pixel values are rounded to the nearest integer when the x-coordinate of a window is changed.


Throws
ArgumentError — If the value set is null or invalid.
 
IllegalOperationError — If the property is accessed after this window has been closed.

See also

y

property 
y:Number

Runtime Versions:  1.0

The vertical axis coordinate of this window's top left corner relative to the upper left corner of the operating system's desktop.

On systems with more than one monitor, y can be negative. If you save the value, perhaps to reposition a window at its previous location, you should always verify that the window is placed in a usable location when the position is restored. Changes in screen resolution or monitor arrangement can can result in a window being placed off screen. Use the Screen class to obtain information about the desktop geometry.

Changing the y property of a window is equivalent to changing the location through the bounds property.

On Linux, setting the y property is an asynchronous operation.

To detect the completion of the position change, listen for the move event, which is dispatched on all platforms.

Pixel values are rounded to the nearest integer when the y-coordinate of a window is changed.


Throws
ArgumentError — If the value set is null or invalid.
 
IllegalOperationError — If the property is accessed after this window has been closed.

See also

Constructor Detail

NativeWindow

()Constructor
public function NativeWindow(initOptions:NativeWindowInitOptions)

Runtime Versions:  1.0

Creates a new NativeWindow instance and a corresponding operating system window.

The settings defined in the initOptions parameter cannot be changed after the window is created. Invalid initOptions settings will cause an illegal operation error to be thrown. Settings that are valid but not available on the current system will not throw an exception. The window capabilities specific to the current operating system can be detected, if desired, using the static NativeWindow members such as systemMaxSize.

The default window size is determined by the operating system, and windows are created in an invisible state. To prevent changes to the window from being visible, do not change the window visible property to true or call activate() until the window changes are finished.

Parameters
initOptions:NativeWindowInitOptions — An object containing the initialization properties for this window.

Throws
IllegalOperationError — If the initOptions parameter is invalid.

See also

Method Detail

activate

()method
public function activate():void

Runtime Versions:  1.0

Activates this window.

Activating a window will:

  • Make the window visible
  • Bring the window to the front
  • Give the window keyboard and mouse focus

On Linux, activate() is an asynchronous operation.

The NativeWindow object dispatches an activate event on all platforms.

See also


Example  ( How to use this example )



Activate a window:
window.nativeWindow.activate();

close

()method 
public function close():void

Runtime Versions:  1.0

Closes this window.

A close event is dispatched as soon as the close operation is complete. A closing event will not be dispatched. If cancellation of the close operation should be allowed, dispatch a closing event and check whether any registered listeners cancel the default behavior before calling the close() method.

When a window is closed, any windows that it owns are also closed. The owned windows do not dispatch closing events.

If display object instances that are currently in the window are not referenced elsewhere they will be garbage collected and destroyed, except on the initial application window created by AIR. To allow display objects on the initial window to be garbage collected, remove them from the window stage.

After being closed, the NativeWindow object is still a valid reference, but accessing most properties and methods will throw an illegal operation error.

Closed windows cannot be reopened. If the window is already closed, no action is taken and no events are dispatched.

Note: to hide a window without closing it, set the window's visible property to false.

See also


Example  ( How to use this example )



Close a window:
window.close();

Or:
window.nativeWindow.close();


The following example illustrates how to close a window from a while allowing the operation to be canceled:
<script src="AIRAliases.js" type="text/javascript"></script>
<script type="text/javascript">
    var dirtyData = false;
    function closeWindow(){
            var closingEvent = new air.Event(air.Event.CLOSING,true,true);
            window.nativeWindow.dispatchEvent(closingEvent);
               if(!closingEvent.isDefaultPrevented()){
                   window.nativeWindow.close();
                //or use: window.close(); 
               return true;
           } else {
               return false;
        }
    }
        
    function onClosing(event){
        if(dirtyData){
            event.preventDefault();
            //Save data...
        }
    }    

    window.nativeWindow.addEventListener(air.Event.CLOSING,onClosing);        
</script>

globalToScreen

()method 
public function globalToScreen(globalPoint:Point):Point

Runtime Versions:  1.0

Converts a point in pixel coordinates relative to the origin of the window stage (a global point in terms of the display list), to a point on the virtual desktop.

Virtual desktop coordinates are relative to the upper, lefthand corner of the primary monitor.

Parameters

globalPoint:Point — The point on the stage to convert to a point on the screen.

Returns
Point — The specified global point relative to the desktop.

See also

listOwnedWindows

()method 
public function listOwnedWindows():Vector.<NativeWindow>

Runtime Versions:  2.6

Returns a list of the NativeWindow objects that are owned by this window.

You cannot change ownership of NativeWindows by adding or removing objects from the returned vector. Window ownership cannot be changed after a window is created.

Returns
Vector.<NativeWindow> — an Vector.<NativeWindow> object containing zero or more NativeWindow objects that are owned by this instance.

See also

maximize

()method 
public function maximize():void

Runtime Versions:  1.0

Maximizes this window.

Calling maximize() method dispatches a displayStateChange event, and, if applicable, a move and a resize event. Whereas system chrome will dispatch a displayStateChanging event that can be canceled when a maximize command is initiated by a user, your maximize logic must implement this behavior, if desired.

The maximize() method executes asynchronously. To detect the completion of the state change, listen for the displayStateChange event. If the window is already maximized, no action is taken and no events are dispatched.

OS behavior notes:

  • On operating systems, such as Mac OS X, in which maximizing a window does not also prevent resizing, calling maximize() will zoom the window to fill the screen, but will not prevent subsequent resizing of the window. Resizing a zoomed window will also restore the display state.
  • On some operating systems, such as Mac OS X, as well as on some Linux window managers, maximizing a window will not expand the window beyond the width and height specified in the maxSize property. On others, the window will expand to fill the screen even if the screen is larger than the maxSize.
  • Some Linux window managers do not allow utility windows to be maximized.


Throws
IllegalOperationError — If this method is called after this window has been closed.

See also


Example  ( How to use this example )


The following example illustrates how to allow cancelation of a maximize operation:
function maximizeWindow(){
    if(window.nativeWindow.displayState != air.NativeWindowDisplayState.MAXIMIZED){
        var beforeState = window.nativeWindow.displayState;
        var afterState = air.NativeWindowDisplayState.MAXIMIZED;
        var displayStateEvent = 
            new air.NativeWindowDisplayStateEvent(air.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING,
                                              true,true,beforeState,afterState);
        nativeWin.dispatchEvent(displayStateEvent);
        if(!displayStateEvent.isDefaultPrevented()){
            window.nativeWindow.maximize();
            return true;
        } else {
          return false;
        }
     }
     return false;
}

minimize

()method 
public function minimize():void

Runtime Versions:  1.0

Minimizes this window.

Calling minimize() dispatches a displayStateChange event, and, if applicable, a move and a resize event. Whereas system chrome will dispatch a displayStateChanging event that can be canceled when a minimize command is initiated by a user, calling minimize() directly does not. Your minimize logic may implement this behavior, if desired.

The minimize() method executes asynchronously. To detect the completion of the state change, listen for the displayStateChange event, which is dispatched on all platforms. If the window is already minimized, no action is taken and no events are dispatched.

Any windows owned by this window are hidden when it is minimized. The owned windows do not dispatch displayStateChanging or displayStateChange events.

Notes:

  • On Windows, minimizing an invisible window (visible == false), will make the window visible.
  • Some Linux window managers do not allow utility windows to be minimized.


Throws
IllegalOperationError — If this method is called after this window has been closed.

See also


Example  ( How to use this example )


The following example illustrates how to allow cancelation of a call to minimize():
 
function minimizeWindow(){
    if( window.nativeWindow.displayState != air.NativeWindowDisplayState.MINIMIZED ){
        var beforeState = window.nativeWindow.displayState;
        var afterState = air.NativeWindowDisplayState.MINIMIZED;
        var displayStateEvent = 
            new air.NativeWindowDisplayStateEvent( air.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING,
                                              true,true,beforeState,afterState );
        window.nativeWindow.dispatchEvent( displayStateEvent );
        if(!displayStateEvent.isDefaultPrevented()){
            window.nativeWindow.minimize();
            return true;
        } else {
          return false;
        }
     }
     return false;
}

notifyUser

()method 
public function notifyUser(type:String):void

Runtime Versions:  1.0

Triggers a visual cue through the operating system that an event of interest has occurred.

When NativeWindow.supportsNotification is true, the visual cue will conform to the operating system convention of the native system. For example, on Windows, the task bar icon will flash.

The type parameter determines the intensity of the cue. Constants for the permitted values are defined in the NotificationType class, and may be:

  • NotificationType.INFORMATIONAL
  • NotificationType.CRITICAL

The cues provided for informational notifications are of short duration; those provided for critical notifications will last until the user activates this window. Not all Linux window managers support two levels of notification. For such window managers, notifyUser() will have the same affect no matter which option is specified.

Note: Calling notifyUser() when NativeWindow.supportsNotification is false is allowed, but does nothing.

Parameters

type:String — A string representing the urgency of the notification.

orderInBackOf

()method 
public function orderInBackOf(window:NativeWindow):Boolean

Runtime Versions:  1.0

Sends this window directly behind the specified window.

Does not activate or acquire the focus for the window or the application. Minimized or hidden (visible is false) windows cannot be reordered.

An owned window can never be moved behind its owner. If this window has an owner, then the owner and its other owned windows are also ordered behind the target. If the target window has an owner, then this window is ordered behind the owner of the target instead.

Some Linux window managers do not allow utility windows to be ordered behind normal windows.

Parameters

window:NativeWindow — An application window.

Returns
Booleantrue if this window was successfully sent to the back; false if this window is invisible or minimized.

Example  ( How to use this example )



Order one window behind another using references to two JavaScript Window objects:
jsWindowObjBehind.nativeWindow.orderInBackOf(jsWindowObjFront.nativeWindow);

orderInFrontOf

()method 
public function orderInFrontOf(window:NativeWindow):Boolean

Runtime Versions:  1.0

Brings this window directly in front of the specified window.

Does not activate or acquire the focus for the window or the application. Minimized or hidden (visible is false) windows cannot be reordered.

A window can never be moved in front of a window that it owns. If this window has an owner, then the owner and its other owned windows are also ordered in front of the target. If the target window has an owner, then this window is also ordered in front of any other windows that have the same owner as the target.

Some Linux window managers do not allow normal windows to be ordered in front of utility windows.

Parameters

window:NativeWindow — An application window.

Returns
Booleantrue if this window was successfully brought to the front; false if this window is invisible or minimized.

Example  ( How to use this example )



Order one window in front of another using references to two JavaScript window objects:
jsWindowObjFront.nativeWindow.orderInFrontOf(jsWindowObjBehind.nativeWindow);

orderToBack

()method 
public function orderToBack():Boolean

Runtime Versions:  1.0

Sends this window behind any other visible windows.

Does not activate or acquire the focus for this window or the application. Minimized or hidden (visible is false) windows cannot be reordered.

If alwaysInFront is true, then calling this method will not send this window behind any windows which have alwaysInFront set to false.

An owned window can never be moved behind its owner. If this window has an owner, then the owner and its other owned windows are also ordered to the bottom of window display list. This window will move behind any other windows owned by the same window. If this window owns other windows, then those windows are also moved to the back, maintaining their current order relative to each other.

Some Linux window managers do not allow utility windows to be ordered behind normal windows.

Returns
Booleantrue if this window was successfully sent to the back; false if this window is invisible or minimized.

Example  ( How to use this example )



Put a window at the bottom of the display order:
window.nativeWindow.orderToBack();

orderToFront

()method 
public function orderToFront():Boolean

Runtime Versions:  1.0

Brings this window in front of any other visible windows.

Does not activate or acquire the focus for this window or the application. Minimized or hidden (visible is false) windows cannot be reordered.

If alwaysInFront is false, then calling this method will not send this window in front of any windows which have alwaysInFront set to true.

A window can never be moved in front of a window that it owns. If this window owns other windows, then those windows are also moved to the front, maintaining their current order relative to each other. If this window has an owner, then the owner and its other owned windows are also ordered to the front of the window display order. This window is moved in front of other windows that have the same owner.

Some Linux window managers do not allow normal windows to be ordered in front of utility windows.

Returns
Booleantrue if this window was successfully brought to the front; false if this window is invisible or minimized.

Example  ( How to use this example )



Bring a window to the front of the display order:
window.nativeWindow.orderToFront();

restore

()method 
public function restore():void

Runtime Versions:  1.0

Restores this window from either a minimized or a maximized state.

Calling restore() dispatches a displayStateChange event, and, if applicable, a move and a resize event. Whereas system chrome will dispatch a displayStateChanging event that can be canceled when a restore command is initiated by a user, your restore logic must implement this behavior, if desired.

If the window is already in the NativeWindowDisplayState.NORMAL state, no action is taken and no events are dispatched.

To detect the completion of the state change, listen for the displayStateChange event, which is dispatched on all platforms.


Throws
IllegalOperationError — If the method is called after this window has been closed.

See also


Example  ( How to use this example )


The following example illustrates how to allow cancelation of a restore operation:
function restoreWindow(){
    if(window.nativeWindow.displayState != air.NativeWindowDisplayState.NORMAL){
        var beforeState = window.nativeWindow.displayState;
        var afterState = air.NativeWindowDisplayState.NORMAL;
        var displayStateEvent = 
            new air.NativeWindowDisplayStateEvent(air.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING,
                                              true,true,beforeState,afterState);
        window.nativeWindow.dispatchEvent(displayStateEvent);
        if(!displayStateEvent.isDefaultPrevented()){
            window.nativeWindow.restore();
            return true;
        } else {
          return false;
        }
     }
     return false;
}

startMove

()method 
public function startMove():Boolean

Runtime Versions:  1.0

Starts a system-controlled move of this window.

When called from a mouseDown event, this method begins a mouse-driven move sequence that continues until a mouseUp event occurs.

When called from other code this method begins a keyboard- or mouse-driven move sequence consistent with the operating system's default sequence.

During a move sequence, a series of events will be dispatched as the window origin moves. For each incremental move, first a moving event is dispatched and then, if the moving event is not canceled, the window location is updated and a move event is dispatched. If a moving event is canceled, the move sequence is immediately terminated.

Returns
Booleantrue if the move was successfully initiated and false if the window is maximized.

Throws
IllegalOperationError — If the method is called after this window has been closed.

startResize

()method 
public function startResize(edgeOrCorner:String = "BR"):Boolean

Runtime Versions:  1.0

Starts a system-controlled resize operation of this window.

When called from a mouseDown event handler this method begins a mouse-driven resizing sequence that continues until a mouseUp event occurs.

When called from other code this method begins a keyboard- or mouse-driven resizing sequence consistent with the operating system's default sequence.

During the resize sequence, a series of events will be dispatched as the window dimensions change. For each incremental change, first a resizing event is dispatched and then, if the resizing event is not canceled, the window dimensions are updated and a resize event is dispatched. If a resizing event is canceled, the the sequence is immediately terminated.

Parameters

edgeOrCorner:String (default = "BR") — A constant from the NativeWindowResize class that specifies which edge or corner of this window to resize. The following are valid values:

ValueVertical alignmentHorizontal alignment
NativeWindowResize.TOPTopCenter
NativeWindowResize.BOTTOMBottomCenter
NativeWindowResize.LEFTCenterLeft
NativeWindowResize.RIGHTCenterRight
NativeWindowResize.TOP_LEFTTopLeft
NativeWindowResize.TOP_RIGHTTopRight
NativeWindowResize.BOTTOM_LEFTBottomLeft
NativeWindowResize.BOTTOM_RIGHTBottomRight
NativeWindowResize.NONE----

Returns
Booleantrue if the resize was successfully initiated and false if the window is maximized.

Throws
IllegalOperationError — If the method is called after this window has been closed.

See also

Event Detail

activate

Event
Event Object Type: flash.events.Event
property Event.type = flash.events.Event.ACTIVATE

Runtime Versions:  1.0

Dispatched by this NativeWindow object after the window has been activated.

The ACTIVATE constant defines the value of the type property of an activate event object.

Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to any potential targets, whether the target is on the display list or not.

AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetAny DisplayObject instance with a listener registered for the activate event.

close

Event  
Event Object Type: flash.events.Event
property Event.type = flash.events.Event.CLOSE

Runtime Versions:  1.0

Dispatched by this NativeWindow object after the window has been closed.

The Event.CLOSE constant defines the value of the type property of a close event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object whose connection has been closed.

closing

Event  
Event Object Type: flash.events.Event
property Event.type = flash.events.Event.CLOSING

Runtime Versions:  1.0

Dispatched by this NativeWindow object immediately before the window is to be closed. This event can be canceled to prevent the window from being closed.

The Event.CLOSING constant defines the value of the type property of a closing event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelabletrue; canceling this event object stops the close operation.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object whose connection is to be closed.

deactivate

Event  
Event Object Type: flash.events.Event
property Event.type = flash.events.Event.DEACTIVATE

Runtime Versions:  1.0

Dispatched by this NativeWindow object after the window has been deactivated.

The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.

Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to any potential targets, whether the target is on the display list or not.

AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetAny DisplayObject instance with a listener registered for the deactivate event.

displayStateChange

Event  
Event Object Type: flash.events.NativeWindowDisplayStateEvent
property NativeWindowDisplayStateEvent.type = flash.events.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGE

Runtime Versions:  1.0

Dispatched by this NativeWindow object after the window's displayState property has changed.

Do not resize the window or change its display state in the displayStateChange event handler.

Defines the value of the type property of a displayStateChange event object.

This event has the following properties:

PropertiesValues
afterDisplayStateThe old display state of the window.
beforeDisplayStateThe new display state of the window.
targetThe NativeWindow instance that has just changed state.
bubblesNo.
currentTargetIndicates the object that is actively processing the Event object with an event listener.
cancelablefalse; There is no default behavior to cancel.

displayStateChanging

Event  
Event Object Type: flash.events.NativeWindowDisplayStateEvent
property NativeWindowDisplayStateEvent.type = flash.events.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING

Runtime Versions:  1.0

Dispatched by this NativeWindow object immediately before the window changes its display state. This event can be canceled to prevent the change.

Defines the value of the type property of a displayStateChanging event object.

This event has the following properties:

PropertiesValues
afterDisplayStateThe display state of the window before the pending change.
beforeDisplayStateThe display state of the window after the pending change.
targetThe NativeWindow instance that has just changed state.
bubblesNo.
currentTargetIndicates the object that is actively processing the Event object with an event listener.
cancelabletrue; canceling the event will prevent the change.

move

Event  
Event Object Type: flash.events.NativeWindowBoundsEvent
property NativeWindowBoundsEvent.type = flash.events.NativeWindowBoundsEvent.MOVE

Runtime Versions:  1.0

Dispatched by this NativeWindow object after the window has been moved on the desktop.

A move event is dispatched whenever the origin (x or y properties) of the window changes, which can occur because of a system-controlled window move; minimizing, maximizing, or restoring the window; or changing the window location by setting the x, y, or bounds properties.

Note: Avoid actions that may open simultaneous operating system dialogs boxes in the handler functions for both the moving and move events of a NativeWindow object. This may occur, for example, if both handler functions throw an error. If it does occur, the second dialog box opened will not register mouse clicks and must be closed using the keyboard.

Defines the value of the type property of a move event object.

This event has the following properties:

PropertiesValues
afterBoundsThe new bounds of the window.
beforeBoundsThe old bounds of the window.
targetThe NativeWindow object that has just changed state.
bubblesNo.
currentTargetIndicates the object that is actively processing the Event object with an event listener.
cancelablefalse; There is no default behavior to cancel.

moving

Event  
Event Object Type: flash.events.NativeWindowBoundsEvent
property NativeWindowBoundsEvent.type = flash.events.NativeWindowBoundsEvent.MOVING

Runtime Versions:  1.0

Dispatched by the NativeWindow object immediately before the window is to be moved on the desktop. This event can be canceled to prevent or modify the move.

Note: Avoid actions that may open simultaneous operating system dialogs boxes in the handler functions for both the moving and move events of a NativeWindow object. This may occur, for example, if both handler functions throw an error. If it does occur, the second dialog box opened will not register mouse clicks and must be closed using the keyboard.

Defines the value of the type property of a moving event object.

This event has the following properties:

PropertiesValues
afterBoundsThe bounds of the window after the pending change.
beforeBoundsThe bounds of the window before the pending change.
bubblesNo.
cancelabletrue; cancelling the event will prevent the window move.
currentTargetIndicates the object that is actively processing the Event object with an event listener.
targetThe NativeWindow object that has just changed state.

Note: On Linux, the preventDefault() method is not supported for this event.

resize

Event  
Event Object Type: flash.events.NativeWindowBoundsEvent
property NativeWindowBoundsEvent.type = flash.events.NativeWindowBoundsEvent.RESIZE

Runtime Versions:  1.0

Dispatched by this NativeWindow object after the window has been resized. A resize event is dispatched whenever the size (width or height properties) of the window changes, which can occur because of a system-controlled window resize; minimizing, maximizing, or restoring the window; or changing the window size by setting the width, height, or bounds properties. NativeWindow resize events are dispatched during system-controled resize loops. In contrast, Stage object resize events are dispatched when the Stage is ready for drawing.

Defines the value of the type property of a resize event object.

This event has the following properties:

PropertiesValues
afterBoundsThe new bounds of the window.
beforeBoundsThe old bounds of the window.
targetThe NativeWindow object that has just changed state.
bubblesNo.
currentTargetIndicates the object that is actively processing the Event object with an event listener.
cancelablefalse; There is no default behavior to cancel.

See also

resizing

Event  
Event Object Type: flash.events.NativeWindowBoundsEvent
property NativeWindowBoundsEvent.type = flash.events.NativeWindowBoundsEvent.RESIZING

Runtime Versions:  1.0

Dispatched by this NativeWindow object immediately before the window is to be resized on the desktop. This event can be canceled to prevent or modify the resize.

Defines the value of the type property of a resizing event object.

This event has the following properties:

PropertiesValues
afterBoundsThe bounds of the window after the pending change.
beforeBoundsThe bounds of the window before the pending change.
targetThe NativeWindow object that has just changed state.
bubblesNo.
currentTargetIndicates the object that is actively processing the Event object with an event listener.
cancelabletrue; cancelling the event will prevent the window move.

Note: On Linux, the preventDefault() method is not supported for this event.