Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
flash.display 
NativeWindow 
Packageflash.display
Classpublic class NativeWindow
InheritanceNativeWindow Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 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. A reference to a NativeWindow instance can also be accessed using the stage.nativeWindow property of any display object on that window's stage:

var window:NativeWindow = displayObject.stage.nativeWindow;

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().

You cannot not add Flex components directly to the display list of a NativeWindow instance. Instead, use the Flex mx:WindowedApplication and mx:Window components to create your windows and add the other Flex components as children of those objects. You can add Flex-based SWF content directly to a NativeWindow window as long as the SWF file is loaded into its own application domain and is application content.

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



Public Properties
 PropertyDefined By
  AIR-only active : Boolean
[read-only] Indicates whether this window is the active application window.
NativeWindow
  AIR-only alwaysInFront : Boolean
Specifies whether this window will always be in front of other windows (including those of other applications).
NativeWindow
  AIR-only bounds : Rectangle
The size and location of this window.
NativeWindow
  AIR-only 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
  AIR-only displayState : String
[read-only] The display state of this window.
NativeWindow
  AIR-only height : Number
The height of this window in pixels.
NativeWindow
  AIR-only maximizable : Boolean
[read-only] Reports the maximizable setting used to create this window.
NativeWindow
  AIR-only maxSize : Point
The maximum size for this window.
NativeWindow
  AIR-only menu : NativeMenu
The native menu for this window.
NativeWindow
  AIR-only minimizable : Boolean
[read-only] Reports the minimizable setting used to create this window.
NativeWindow
  AIR-only minSize : Point
The minimum size for this window.
NativeWindow
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  AIR-only resizable : Boolean
[read-only] Reports the resizable setting used to create this window.
NativeWindow
  AIR-only stage : Stage
[read-only] The Stage object for this window.
NativeWindow
  AIR-only supportsMenu : Boolean
[static] [read-only] Indicates whether AIR supports native window menus on the current computer system.
NativeWindow
  AIR-only supportsNotification : Boolean
[static] [read-only] Indicates whether AIR supports window notification cueing on the current computer system.
NativeWindow
  AIR-only supportsTransparency : Boolean
[static] [read-only] Indicates whether AIR supports native windows with transparent pixels.
NativeWindow
  AIR-only systemChrome : String
[read-only] Reports the system chrome setting used to create this window.
NativeWindow
  AIR-only systemMaxSize : Point
[static] [read-only] The largest window size allowed by the operating system.
NativeWindow
  AIR-only systemMinSize : Point
[static] [read-only] The smallest window size allowed by the operating system.
NativeWindow
  AIR-only title : String
The window title.
NativeWindow
  AIR-only transparent : Boolean
[read-only] Reports the transparency setting used to create this window.
NativeWindow
  AIR-only type : String
[read-only] Reports the window type setting used to create this window.
NativeWindow
  AIR-only visible : Boolean
Specifies whether this window is visible.
NativeWindow
  AIR-only width : Number
The width of this window in pixels.
NativeWindow
  AIR-only x : Number
The horizontal axis coordinate of this window's top left corner relative to the origin of the operating system desktop.
NativeWindow
  AIR-only 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
  
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
  
Closes this window.
NativeWindow
 Inherited
Dispatches an event into the event flow.
EventDispatcher
  
AIR-only globalToScreen(globalPoint:Point):Point
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
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
Maximizes this window.
NativeWindow
  
Minimizes this window.
NativeWindow
  
Triggers a visual cue through the operating system that an event of interest has occurred.
NativeWindow
  
Sends this window directly behind the specified window.
NativeWindow
  
Brings this window directly in front of the specified window.
NativeWindow
  
Sends this window behind any other visible windows.
NativeWindow
  
Brings this window in front of any other visible windows.
NativeWindow
 Inherited
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
  
Restores this window from either a minimized or a maximized state.
NativeWindow
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
Starts a system-controlled move of this window.
NativeWindow
  
AIR-only startResize(edgeOrCorner:String):Boolean
Starts a system-controlled resize operation of this window.
NativeWindow
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
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
AIR-only 

active

property
active:Boolean  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Indicates whether this window is the active application window.

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



Implementation
    public function get active():Boolean

See also

AIR-only 

alwaysInFront

property 
alwaysInFront:Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 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.

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.

Some Linux window managers always display utility windows in front of normal windows.

Note: On Mac® OS X, setting alwaysInFront to true will have no effect when the displayState property of the window stage is fullScreen or fullScreenInteractive. On Linux, fullscreen windows with alwaysInFront set to true always display in front of other windows that have alwaysInFront set to true.



Implementation
    public function get alwaysInFront():Boolean
    public function set alwaysInFront(value:Boolean):void

Example  ( How to use this example )
The following examples force a window to be displayed in front of all other windows (that are not similarly forced to the front):
windowObj.alwaysInFront = true;
With a reference to a display object on the window stage:
displayObject.stage.nativeWindow.alwaysInFront=true;
From a JavaScript routine running in an HTMLLoader object in the window (or a root HTML window):
window.nativeWindow.alwaysInFront = true;
AIR-only 

bounds

property 
bounds:Rectangle

Language Version: ActionScript 3.0
Runtime Versions: AIR 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 outerHeigth 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 2880 pixels.
  • The minimum width and height required by any displayed system chrome.



Implementation
    public function get bounds():Rectangle
    public function set bounds(value:Rectangle):void

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 )
The following examples set the bounds of a window with a reference to a NativeWindow object:
windowObj.bounds = new Rectangle(200, 200, 1000, 800);
With a reference to a display object on the window stage:
displayObject.stage.nativeWindow.bounds = new Rectangle(20, 20, 800, 600);
From a JavaScript routine running in an HTMLLoader object in the window (or a root HTML window):
window.nativeWindow.bounds = new air.Rectangle(20, 20, 800, 600);
AIR-only 

closed

property 
closed:Boolean  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 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()



Implementation
    public function get closed():Boolean

Example  ( How to use this example )
The following examples show how to access the closed property of a window:
var isWindowClosed:Boolean = windowObj.closed;
With a reference to a display object on the window stage:
var isWindowClosed:Boolean = displayObject.stage.nativeWindow.closed;
From a JavaScript routine running in an HTMLLoader object in the window (or root HTML window):
var isWindowClosed = window.nativeWindow.closed;
AIR-only 

displayState

property 
displayState:String  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 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



Implementation
    public function get displayState():String

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

See also


Example  ( How to use this example )
The following example shows how to get the current window display state given a reference to the window object:
var state:String = windowObj.displayState;
AIR-only 

height

property 
height:Number

Language Version: ActionScript 3.0
Runtime Versions: AIR 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 2880 pixels.

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.



Implementation
    public function get height():Number
    public function set height(value:Number):void

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

See also

AIR-only 

maximizable

property 
maximizable:Boolean  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Reports the maximizable setting used to create this window.

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

Not all Linux window managers honor the maximizable setting.



Implementation
    public function get maximizable():Boolean

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

AIR-only 

maxSize

property 
maxSize:Point

Language Version: ActionScript 3.0
Runtime Versions: AIR 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 ActionScript 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 value is set to the closest legal size. The factors that determine the 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 2880 pixels for 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.



Implementation
    public function get maxSize():Point
    public function set maxSize(value:Point):void

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 )
The following examples show how to set the maximum allowed size for a window.
windowObj.maxSize = new Point(1040,920);
With a reference to a display object on the window stage:
displayObject.stage.nativeWindow.maxSize = new Point(800,600);
From a JavaScript routine running in an HTMLLoader object in a window (or in a root HTML window):
window.nativeWindow.maxSize = new air.Point(960,960);
AIR-only 

menu

property 
menu:NativeMenu

Language Version: ActionScript 3.0
Runtime Versions: AIR 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).



Implementation
    public function get menu():NativeMenu
    public function set menu(value:NativeMenu):void

See also

AIR-only 

minimizable

property 
minimizable:Boolean  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Reports the minimizable setting used to create this window.

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

Not all Linux window managers honor the minimizable setting.



Implementation
    public function get minimizable():Boolean

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

AIR-only 

minSize

property 
minSize:Point

Language Version: ActionScript 3.0
Runtime Versions: AIR 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 ActionScript 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.



Implementation
    public function get minSize():Point
    public function set minSize(value:Point):void

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 )
The following examples show how to set the minimum allowed size for a window:
windowObj.minSize = new Point(200,80);
With a reference to a display object on the window stage:
displayObject.stage.nativeWindow.minSize = new Point(120,60);
From a JavaScript routine running in an HTMLLoader object in a window (or in a root HTML window):
window.nativeWindow.minSize = new air.Point(80,60);
AIR-only 

resizable

property 
resizable:Boolean  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Reports the resizable setting used to create this window.

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



Implementation
    public function get resizable():Boolean

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

AIR-only 

stage

property 
stage:Stage  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The Stage object for this window. The Stage object is the root object in the display list architecture used in ActionScript 3.0-based SWF content.

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.



Implementation
    public function get stage():Stage

See also


Example  ( How to use this example )
The following example shows how to set stage properties for a NativeWindow instance:
import flash.display.StageAlign;

windowObj.stage.align = StageAlign.TOP_LEFT;
AIR-only 

supportsMenu

property 
supportsMenu:Boolean  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 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.



Implementation
    public static function get supportsMenu():Boolean

See also

AIR-only 

supportsNotification

property 
supportsNotification:Boolean  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 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.



Implementation
    public static function get supportsNotification():Boolean

See also

AIR-only 

supportsTransparency

property 
supportsTransparency:Boolean  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 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 appliction is running, based on user preferences set for the operating system.



Implementation
    public static function get supportsTransparency():Boolean

See also

AIR-only 

systemChrome

property 
systemChrome:String  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 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.



Implementation
    public function get systemChrome():String

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 )
The following example shows how to get the system chrome type for a window:
var sysChromeType:String = windowObj.systemChrome;
With a reference to a display object on the window stage:
var sysChromeType:String = displayObject.stage.nativeWindow.systemChrome;
From a JavaScript routine running in an HTMLLoader object in the window (or root HTML window):
var sysChromeType = window.nativeWindow.systemChrome;
The following example shows how to change the apparent system chrome and transparency settings by creating a new window and moving all child display objects to the new window:
import flash.display.NativeWindow;
import flash.display.NativeWindowSystemChrome;
import flash.display.NativeWindowInitOptions;

public function deChromeWindow(oldWindow:NativeWindow):NativeWindow{
    if(oldWindow.systemChrome != NativeWindowSystemChrome.NONE){
        var newOptions:NativeWindowInitOptions = new NativeWindowInitOptions();
        newOptions.systemChrome = NativeWindowSystemChrome.NONE;
        newOptions.transparent = true;
        
        var newWindow:NativeWindow = new NativeWindow(newOptions);
        newWindow.stage.stageWidth = oldWindow.stage.stageWidth;
        newWindow.stage.stageHeight = oldWindow.stage.stageHeight;
        newWindow.stage.align = oldWindow.stage.align;
        newWindow.stage.scaleMode = oldWindow.stage.scaleMode;
        
        for(var i:int = 0; i < oldWindow.stage.numChildren; i++){
            newWindow.stage.addChild(oldWindow.stage.getChildAt(i));
        }
        newWindow.activate();
        oldWindow.close();
        
        return newWindow;
    }
    return oldWindow;
}

AIR-only 

systemMaxSize

property 
systemMaxSize:Point  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 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 2880 by 2880 pixels. And an application can set a limit using the maxSize property of the NativeWindow object.



Implementation
    public static function get systemMaxSize():Point
AIR-only 

systemMinSize

property 
systemMinSize:Point  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 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.



Implementation
    public static function get systemMinSize():Point
AIR-only 

title

property 
title:String

Language Version: ActionScript 3.0
Runtime Versions: AIR 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).



Implementation
    public function get title():String
    public function set title(value:String):void

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

Example  ( How to use this example )
The following example sets the title of a window object:
windowObj.title = "Window Title";
AIR-only 

transparent

property 
transparent:Boolean  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 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.



Implementation
    public function get transparent():Boolean

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

AIR-only 

type

property 
type:String  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 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.



Implementation
    public function get type():String

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

AIR-only 

visible

property 
visible:Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 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().

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.



Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void

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 )
The following examples show how to access the visible property of a window:
windowObj.visible = true;
With a reference to a display object on the window stage:
displayObj.stage.nativeWindow.visible = true;
From a JavaScript routine running in an HTMLLoader object in the window (or root HTML window):
window.nativeWindow.visible = true;
AIR-only 

width

property 
width:Number

Language Version: ActionScript 3.0
Runtime Versions: AIR 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 2880 pixels.

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.



Implementation
    public function get width():Number
    public function set width(value:Number):void

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

See also

AIR-only 

x

property 
x:Number

Language Version: ActionScript 3.0
Runtime Versions: AIR 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.



Implementation
    public function get x():Number
    public function set x(value:Number):void

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

See also

AIR-only 

y

property 
y:Number

Language Version: ActionScript 3.0
Runtime Versions: AIR 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.



Implementation
    public function get y():Number
    public function set y(value:Number):void

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
AIR-only 

NativeWindow

()Constructor
public function NativeWindow(initOptions:NativeWindowInitOptions)

Language Version: ActionScript 3.0
Runtime Versions: AIR 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, but can be changed by setting the window bounds. The change will not be visible if the window visible property is false.

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

Throws
IllegalOperationError — If the initOptions parameter is invalid.

See also


Example  ( How to use this example )

The following example creates and activates a new NativeWindow instance:
import flash.display.NativeWindowInitOptions;
import flash.display.NativeWindowSystemChrome;
import flash.display.NativeWindowType;
import flash.display.NativeWindow;
import flash.display.StageAlign;
import flash.display.StageScaleMode;
import flash.geom.Rectangle;

var windowOptions:NativeWindowInitOptions = new NativeWindowInitOptions();
windowOptions.systemChrome = NativeWindowSystemChrome.STANDARD;
windowOptions.type = NativeWindowType.NORMAL;

var newWindow:NativeWindow = new NativeWindow(windowOptions);
newWindow.stage.scaleMode = StageScaleMode.NO_SCALE;
newWindow.stage.align = StageAlign.TOP_LEFT;
newWindow.bounds = new Rectangle(100, 100, 800, 800);

newWindow.activate();
Method Detail

AIR-only activate

()method
public function activate():void

Language Version: ActionScript 3.0
Runtime Versions: AIR 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 )

The following examples show how to activate a window.

With a reference to a display object on the window stage:

displayObject.stage.nativeWindow.activate();

With a reference to an instance of the NativeWindow class:
windowObj.activate();

From JavaScript in an HTML page rendered in the window (where window is the global JavaScript window object):
window.nativeWindow.activate();

AIR-only close

()method 
public function close():void

Language Version: ActionScript 3.0
Runtime Versions: AIR 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.

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 )

The following examples show how to close a window:

With a reference to the NativeWindow instance (windowObj):

windowObj.close();


With a reference to a display object on the window stage:
displayObj.stage.nativeWindow.close();

From a JavaScript routine running in an HTMLLoader object (or HTML root window):
window.close(); //overriddable in HTMLHost

Or:
window.nativeWindow.close(); //not overriddable

The following example illustrates how to allow cancellation of a close operation (where windowObj is the NativeWindow instance to be closed):
public function closeCommand():Boolean{
    var closeEvent:Event = new Event(Event.CLOSING,true,true);
    windowObj.dispatchEvent(closeEvent);
    if(!closeEvent.isDefaultPrevented()){
        windowObj.close();
        return true;
    } else {
      return false;
    }
}

The following example illustrates how to close a window from a JavaScript routine running in an HTMLLoader object (or HTML root window), 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>

AIR-only globalToScreen

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

Language Version: ActionScript 3.0
Runtime Versions: AIR 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

AIR-only maximize

()method 
public function maximize():void

Language Version: ActionScript 3.0
Runtime Versions: AIR 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.

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 the maximizable property of this window is false or 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 maximize operation:
public function maximizeWindow(nativeWin:NativeWindow):Boolean{
  if(nativeWin.displayState != NativeWindowDisplayState.MAXIMIZED){
    var beforeState:String = nativeWin.displayState;
    var afterState:String = NativeWindowDisplayState.MAXIMIZED;
    var displayStateEvent:NativeWindowDisplayStateEvent = 
        new NativeWindowDisplayStateEvent(NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING,
                                              true,true,beforeState,afterState);
    nativeWin.dispatchEvent(displayStateEvent);
    if(!displayStateEvent.isDefaultPrevented()){
        nativeWin.maximize();
        return true;
    } else {
      return false;
    }
  }
  return false;
}

The following example illustrates how to allow cancelation of a maximize operation from a JavaScript routine running in an HTMLLoader object on the window (or an HTML window):
function maximizeWindow(nativeWin){
    if(nativeWin.displayState != air.NativeWindowDisplayState.MAXIMIZED){
        var beforeState = nativeWin.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()){
            nativeWin.maximize();
            return true;
        } else {
          return false;
        }
     }
     return false;
}

AIR-only minimize

()method 
public function minimize():void

Language Version: ActionScript 3.0
Runtime Versions: AIR 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. If the window is already minimized, no action is taken and no events are dispatched.

Some Linux window managers do not allow utility windows to be minimized.


Throws
IllegalOperationError — If the minimizable property of this window is false or 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 call to minimize() by dispatching a displayStateChanging event:
public function minimizeWindow(nativeWin:NativeWindow):Boolean{
    if(nativeWin.displayState != NativeWindowDisplayState.MINIMIZED){
        var beforeState:String = nativeWin.displayState;
        var afterState:String = NativeWindowDisplayState.MINIMIZED;
        var displayStateEvent:NativeWindowDisplayStateEvent = 
            new NativeWindowDisplayStateEvent(NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING,
                                              true,true,beforeState,afterState);
        nativeWin.dispatchEvent(displayStateEvent);
        if(!displayStateEvent.isDefaultPrevented()){
            nativeWin.minimize();
            return true;
        } else {
          return false;
        }
     }
     return false;
}

The following example illustrates how to allow cancelation of a call to minimize() in JavaScript running in an HTMLLoader object (or HTML window):
 
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;
}

AIR-only notifyUser

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

Runtime Versions: AIR 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.

AIR-only orderInBackOf

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

Language Version: ActionScript 3.0
Runtime Versions: AIR 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.

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 succesfully sent to the back; false if this window is invisible or minimized.

Example  ( How to use this example )

The following examples show how to move a window just below another window with references to the NativeWindow instances:
windowBehind.orderInBackOf(windowFront);

With references to display objects on the window stages:
displayObjBehind.stage.nativeWindow.orderInBackOf(displayObjectFront.stage.nativeWindow);


From a JavaScript routine running in an HTMLLoader object (or HTML root window) using references to two JavaScript Window objects:
jsWindowObjBehind.nativeWindow.orderInBackOf(jsWindowObjFront.nativeWindow);

AIR-only orderInFrontOf

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

Language Version: ActionScript 3.0
Runtime Versions: AIR 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.

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 succesfully brought to the front; false if this window is invisible or minimized.

Example  ( How to use this example )

The following examples show how to move a window just above another window with references to the NativeWindow instances:
windowFront.orderInFrontOf(windowBehind);

With references to display objects on the window stages:
displayObjFront.stage.nativeWindow.orderInFrontOf(displayObjectBehind.stage.nativeWindow);


From a JavaScript routine running in an HTMLLoader object (or HTML root window) using references to two JavaScript window objects:
jsWindowObjFront.nativeWindow.orderInFrontOf(jsWindowObjBehind.nativeWindow);

AIR-only orderToBack

()method 
public function orderToBack():Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 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.

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

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

Example  ( How to use this example )

The following examples show how to move a window behind all other windows in the application (with the same alwaysInFront setting):
windowObj.orderToBack();


With a reference to a display object on the window stage:
displayObj.stage.nativeWindow.orderToBack();

From a JavaScript routine running in an HTMLLoader object in the window (or a root HTML window):
window.nativeWindow.orderToBack();

AIR-only orderToFront

()method 
public function orderToFront():Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 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.

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

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

Example  ( How to use this example )

The following examples show how to move a window in front of all other windows in the application (with the same alwaysInFront setting):
windowObj.orderToFront();


With a reference to a display object on the window stage:
displayObj.stage.nativeWindow.orderToFront();

From a JavaScript routine running in an HTMLLoader object in the window (or a root HTML window):
window.nativeWindow.orderToFront();

AIR-only restore

()method 
public function restore():void

Language Version: ActionScript 3.0
Runtime Versions: AIR 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:
public function restoreWindow(nativeWin:NativeWindow):Boolean{
    if(nativeWin.displayState != NativeWindowDisplayState.NORMAL){
        var beforeState:String = nativeWin.displayState;
        var afterState:String = NativeWindowDisplayState.NORMAL;
        var displayStateChangingEvent:NativeWindowDisplayStateEvent = 
            new NativeWindowDisplayStateEvent(NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING,
                                              true,true,beforeState,afterState);
        nativeWin.dispatchEvent(displayStateChangingEvent);
        if(!displayStateChangingEvent.isDefaultPrevented()){
            nativeWin.restore();
            return true;
        } else {
          return false;
        }
     }
     return false;
}

The following example illustrates how to allow cancelation of a restore operation from a JavaScript routine running in an HTMLLoader object on the window (or an HTML window):
function restoreWindow(nativeWin){
    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;
}

AIR-only startMove

()method 
public function startMove():Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 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 succesfully initiated and false if the window is maximized.

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

Example  ( How to use this example )

The following example shows how to move a window in response to a mouseDown event:
var initOpts:NativeWindowInitOptions = new NativeWindowInitOptions();
var win:NativeWindow = new NativeWindow(initOpts);
win.activate();
win.stage.addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);

function mouseDownHandler(event:MouseEvent):void
{
    win.startMove();
}

AIR-only startResize

()method 
public function startResize(edgeOrCorner:String):Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 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 = NaN) — 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.NONEBottomRight

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

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

Example  ( How to use this example )

The following example shows how to resize a window in response to a mouseDown event:
stage.addEventListener(MouseEvent.MOUSE_DOWN, onResizeCommand);

function onResizeCommand(event:MouseEvent):void
{
    var win:NativeWindow = event.target.nativeWindow;
    var resizeFrom:String = "";
    if (event.stageY < win.height * .33)
    {
        resizeFrom = NativeWindowResize.TOP;
    }
    else if (event.stageY > win.height * .66)
    {
        resizeFrom = NativeWindowResize.BOTTOM;
    }
    if (event.stageX < win.width * .33)
    {
        resizeFrom += NativeWindowResize.LEFT;
    }
    else if (event.stageX > win.width * .66)
    {
        resizeFrom += NativeWindowResize.RIGHT;
    }
    win.startResize(resizeFrom);    
}
Event Detail
AIR-only 

activate

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

Runtime Versions: AIR 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.

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.
AIR-only 

close

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

Runtime Versions: AIR 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.
AIR-only 

closing

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

Runtime Versions: AIR 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.
AIR-only 

deactivate

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

Runtime Versions: AIR 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.

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.
AIR-only 

displayStateChange

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

Runtime Versions: AIR 1.0

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

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.
AIR-only 

displayStateChanging

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

Runtime Versions: AIR 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.

Example  ( How to use this example )

The following example demonstrates how to cancel a displayStateChanging event.
function displayStateChanging_handler(displayStateEvent:NativeWindowDisplayStateEvent):void
{
  //shouldStopStateChange is an application-defined Boolean indicating 
  //that display state changes should be canceled
  if (displayStateEvent.type == NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING 
                                  &&    shouldStopStateChange)
  {
    displayStateEvent.preventDefault();
  }
}
AIR-only 

move

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

Runtime Versions: AIR 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.
AIR-only 

moving

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

Runtime Versions: AIR 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.
AIR-only 

resize

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

Runtime Versions: AIR 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

AIR-only 

resizing

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

Runtime Versions: AIR 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.

Example  ( How to use this example )

The following example demonstrates how to cancel a resizing event.
function boundsChanging_handler(boundsEvent:NativeWindowBoundsEvent):void
{
  //shouldStopResize is an application-defined Boolean indicating 
  //that resize operations should be canceled
  if (boundsEvent.type == NativeWindowBoundsEvent.RESIZING && shouldStopResize)
  {
    boundsEvent.preventDefault();
  }
}