Packageflash.display
Classpublic class NativeWindow
InheritanceNativeWindow Inheritance EventDispatcher Inheritance Object

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

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

A reference to the NativeWindow 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;

A reference to the NativeWindow 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, a security error will be thrown.

Content can be added to the stage of a window using the DisplayObjectContainer APIs such as addChild().

You should 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 to those objects. You can add a loaded Flex-based SWF directly to a NativeWindow window as long as that SWF 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.createRootContent(). Windows created in this way will have an HTMLLoader added automatically as well as scrollbar support.(From JavaScript code, you can also use the JavaScript window.open() function, although this method gives less control over the window chrome.)

The following operations on NativeWindows 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 it's 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

flash.display.Stage.nativeWindow
flash.display.NativeWindowInitOptions
flash.desktop.NativeApplication
flash.system.ApplicationDomain
flash.html.HTMLLoader#createRootWindow


Public 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] A string reporting this window's current display state.
NativeWindow
  height : Number
The height of this window in pixels.
NativeWindow
  maximizable : Boolean
[read-only] Reports the maximizable setting used to create the window.
NativeWindow
  maxSize : Point
The maximum size for this window.
NativeWindow
  menu : NativeMenu
The native menu for the window.
NativeWindow
  minimizable : Boolean
[read-only] Reports the minimizable setting used to create the window.
NativeWindow
  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
  resizable : Boolean
[read-only] Reports the resizable setting used to create the 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
  systemChrome : String
[read-only] Reports the system chrome setting used to create the 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 the window.
NativeWindow
  type : String
[read-only] Reports the window type setting used to create the 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 upper left corner of the operating system's 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
  
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
  
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 native window according to system rules and behavior.
NativeWindow
  
Minimizes this native window according to system rules and behavior.
NativeWindow
  
Triggers a visual cue through the operating system that an event of interest has occured.
NativeWindow
  
Sends this window directly behind the specified window. Does not activate or acquire the focus for the window or the application.
NativeWindow
  
Brings this window directly in front of the specified window. Does not activate or acquire the focus for the window or the application.
NativeWindow
  
Sends this window behind any other visible windows. Does not activate or acquire the focus for this window or the application.
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
  
startResize(edgeOrCorner:String):Boolean
Starts a system-controlled resize operation of this window.
NativeWindow
 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 has changed.NativeWindow
   Dispatched by this NativeWindow object immediately before the window changes displayState.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
activeproperty
active:Boolean  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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

alwaysInFrontproperty 
alwaysInFront:Boolean  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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=true 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.

alwaysInFront=true should be used sparingly since windows with this setting will appear in front of the windows of other applications even when the other application is active.

Note: On Mac OS X, setting alwaysInFront=true will have no effect when the displayState property of the window stage is fullScreen or fullScreenInteractive.


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

Example

The following example forces 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 display object on the window stage:
displayObject.stage.nativeWindow.alwaysToFront=true;

From a JavaScript routine running in an HTMLLoader in the window (or a root HTML window):
window.nativeWindow.alwaysInFront = true;
boundsproperty 
bounds:Rectangle  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.

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. 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 NativeWindowBoundsChangeEvent "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. Setting the bounds property directly will not dispatch a "moving" or "resizing" event. To allow other components to prepare for or cancel an impending move or resize operation, your bounds changing logic can dispatch "moving" and "resizing" events with the NativeWindow.dispatchEvent method and then check whether the event was cancelled by a registered listener.

Setting the bounds property of a window is equivalent to setting its x, y, width, and height properties (and vice-versa).

If the width and the height specified are less than the minimum or greater than the maximum allowed size, either because of the minSize and maxSize properties of the window, or the minimum and maximum operating system limits, then the window dimensions are set to the closest legal size. The minimum width and height of any displayed system chrome may also result in a window that is larger than the specified size.


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 the window has been closed.

See also


Example

The following example sets the bounds of a window using a reference to the native window:
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 in the window (or a root HTML window):
window.nativeWindow.bounds = new air.Rectangle(20,20,800,600);
closedproperty 
closed:Boolean  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

Indicates whether this window has been closed.

Accessing the following properties on a closed window will throw an IllegalOperationError:

Likewise, calling the following methods on a closed window will also throw an IllegalOperationError:


Implementation
    public function get closed():Boolean

Example

The following example shows 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 in the window (or root HTML window):
var isWindowClosed = window.nativeWindow.closed;
displayStateproperty 
displayState:String  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9

A string reporting this window's current display state.

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


Implementation
    public function get displayState():String

Throws
IllegalOperationError — if the displayState is read after the window has been closed.

See also


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;
heightproperty 
height:Number  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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, either because of the minSize and maxSize properties of the window, or the minimum and maximum operating system limits, then the window height is set to the closest legal size.


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 the window has been closed.

See also

maximizableproperty 
maximizable:Boolean  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

Reports the maximizable setting used to create the window.

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


Implementation
    public function get maximizable():Boolean

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

See also

maxSizeproperty 
maxSize:Point  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

The maximum size for this window.

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

maxSize is enforced for window resizing operations invoked both through ActionScript 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.

Note: 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 the window has been closed.

See also


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 in a window (or in a root HTML window):
window.nativeWindow.maxSize = new air.Point(960,960);
menuproperty 
menu:NativeMenu  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

The native menu for the 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.


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

See also

minimizableproperty 
minimizable:Boolean  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

Reports the minimizable setting used to create the window.

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


Implementation
    public function get minimizable():Boolean

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

See also

minSizeproperty 
minSize:Point  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0icon

The minimum size for this window.

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

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

minSize is enforced for window resizing operations invoked both through ActionScript 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.


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 the window has been closed.

See also


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 in a window (or in a root HTML window):
window.nativeWindow.minSize = new air.Point(80,60);
resizableproperty 
resizable:Boolean  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

Reports the resizable setting used to create the 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 the window has been closed.

See also

stageproperty 
stage:Stage  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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 that 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.


Implementation
    public function get stage():Stage

See also


Example

The following example shows how to set stage properties for a NativeWindow instance:
import flash.display.StageAlign;

windowObj.stage.align = StageAlign.TOP_LEFT;
supportsMenuproperty 
supportsMenu:Boolean  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

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

When NativeWindow.supportsMenu is true, then 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.

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

supportsNotificationproperty 
supportsNotification:Boolean  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

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

When NativeWindow.supportsNotification is true, then calling the window's notify() method will result in a visual cue to the user that an event of interest has occured. 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 notify() when NativeWindow.supportsNotification is false is allowed, but does nothing.


Implementation
    public static function get supportsNotification():Boolean

See also

systemChromeproperty 
systemChrome:String  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

Reports the system chrome setting used to create the 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 the window has been closed.

See also


Example

The following example :

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 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;
}

systemMaxSizeproperty 
systemMaxSize:Point  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0icon

The largest window size allowed by the operating system.

systemMaxSize.x is the maximum window width; systemMaxSize.y is the maximum window height.


Implementation
    public static function get systemMaxSize():Point
systemMinSizeproperty 
systemMinSize:Point  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0icon

The smallest window size allowed by the operating system.

systemMinSize.x is the minimum window width; systemMinSize.y is the minimum window height.


Implementation
    public static function get systemMinSize():Point
titleproperty 
title:String  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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 the window has been closed.

Example

The following example sets the title of a window object:
windowObj.title = "Window Title";
transparentproperty 
transparent:Boolean  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

Reports the transparency setting used to create the 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. If the alpha value of a pixel is below a certain threshold, which varies between about .06 and .01 depending on the operating system, then the window will not capture mouse events above that pixel.


Implementation
    public function get transparent():Boolean

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

See also

typeproperty 
type:String  [read-only]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

Reports the window type setting used to create the 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 the window has been closed.

See also

visibleproperty 
visible:Boolean  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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 the window has been closed.

See also


Example

The following example shows how to access the closed 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 in the window (or root HTML window):
window.nativeWindow.visible = true;
widthproperty 
width:Number  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

The width of this window in pixels.

The dimensions of a NativeWindow 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, either because of the minSize and maxSize properties of the window, or the minimum and maximum operating system limits, then the window width is set to the closest legal size.


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 the window has been closed.

See also

xproperty 
x:Number  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

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

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


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 the window has been closed.

See also

yproperty 
y:Number  [read-write]

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

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

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


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 the window has been closed.

See also

Constructor Detail
NativeWindow()Constructor
public function NativeWindow(initOptions:NativeWindowInitOptions)

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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 will cause an IllegalOperationError 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 the window.

Throws
IllegalOperationError — If the initOptions parameter is invalid.

See also


Example

The following example creates and activates a new NativeWindow:
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,600);

newWindow.activate();
Method Detail
activate()method
public function activate():void

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

Activates this window.

Activating a window will:

See also


Example

The following example shows how to activate a window with a reference to a flash 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();
close()method 
public function close():void

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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 DisplayObject instances that are currently in the window are not referenced elsewhere they will be garbage collected and destroyed.

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

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, set the window's visible property to false.

See also


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 (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 (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()){
                //The following calls are equivalent (by default)
                   window.nativeWindow.close();
                //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

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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

maximize()method 
public function maximize():void

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

Maximizes this native window according to system rules and behavior.

Calling maximize() dispatches a displayStateChange event, and, if applicable, a move and a resize event. Wheras 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.

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

Note: 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.


Throws
IllegalOperationError — if the maximizable property of the window initOptions is false or if the method is called after the window has been closed.

See also


Example

The following example illustrates how to allow cancellation 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 cancellation of a maximize operation:
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;
}
minimize()method 
public function minimize():void

Language Version : ActionScript 3.0
Player Version : Flash Player 9.0

Minimizes this native window according to system rules and behavior.

Calling minimize() dispatches a displayStateChange event, and, if applicable, a move and a resize event. Wheras 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.

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


Throws
IllegalOperationError — if the minimizable property of the window initOptions is false or if the method is called after the window has been closed.

See also


Example

The following example illustrates how to allow cancellation of a call to minimize() by dispatching a DisplayStateChangingEvent:
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 cancellation of a call to minimize() by dispatching a DisplayStateChangingEvent:
 
function minimizeWindow(nativeWin){
    if(nativeWin.displayState != air.NativeWindowDisplayState.MINIMIZED){
        var beforeState = nativeWin.displayState;
        var afterState = air.NativeWindowDisplayState.MINIMIZED;
        var displayStateEvent = 
            new air.NativeWindowDisplayStateEvent(air.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING,
                                              true,true,beforeState,afterState);
        nativeWin.dispatchEvent(displayStateEvent);
        if(!displayStateEvent.isDefaultPrevented()){
            nativeWin.minimize();
            return true;
        } else {
          return false;
        }
     }
     return false;
}
notifyUser()method 
public function notifyUser(type:String):void

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

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:

The cues provided for informational notifications are of short duration; those provided for critical notifications will last until the user activates the window.

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

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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==false) windows cannot be reordered.

If alwaysInFront = true, then sending this window behind a window with alwaysInFront = false will change this window's alwaysInFront property to match.

Parameters

window:NativeWindow — An application window.

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

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 (or HTML root window) using references to two JavaScript window objects:
jsWindowObjBehind.nativeWindow.orderInBackOf(jsWindowObjFront.nativeWindow);
orderInFrontOf()method 
public function orderInFrontOf(window:NativeWindow):Boolean

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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==false) windows cannot be reordered.

If alwaysInFront = false, then bringing this window in front of a window with alwaysInFront = true will change this window's alwaysInFront property to match.

Parameters

window:NativeWindow — An application window.

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

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 (or HTML root window) using references to two JavaScript window objects:
jsWindowObjFront.nativeWindow.orderInFrontOf(jsWindowObjBehind.nativeWindow);

orderToBack()method 
public function orderToBack():Boolean

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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==false) windows cannot be reordered.

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

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

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 in the window (or a root HTML window):
window.nativeWindow.orderToBack();

orderToFront()method 
public function orderToFront():Boolean

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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==false) windows cannot be reordered.

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

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

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 in the window (or a root HTML window):
window.nativeWindow.orderToFront();

restore()method 
public function restore():void

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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. Wheras 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.

restore() executes asynchronously. To detect the completion of the state change, listen for the "displayStateChange" event.

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


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

See also


Example

The following example illustrates how to allow cancellation 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 cancellation of a restore operation:
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;
}
startMove()method 
public function startMove():Boolean

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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 the window has been closed.

Example

The following example shows how to move a window in response to a mouse down event:
import flash.display.NativeWindow;
import flash.events.MouseEvent;

public class MovableWindow extends NativeWindow{
    private function MovableWindow():void{
        super(new NativeWindowInitOptions());
        this.visible = true;
        this.stage.addEventListener(MouseEvent.MOUSE_DOWN, onMoveCommand);
    }
    
    private function onMoveCommand(event:MouseEvent):void{
        this.startMove();
    }
}
startResize()method 
public function startResize(edgeOrCorner:String):Boolean

Language Version : ActionScript 3.0
Player Version : Flash Player 9.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 — A constant from the NativeWindowResize class that specifies which edge or corner of the window to resize. The following are valid values:

ValueVertical AlignmentHorizontal
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 the window has been closed.

Example

The following example shows how to move a window in response to a mouse down event:
public class ResizableWindow extends NativeWindow
{
    public function ResizableWindow()
    {
        var options:NativeWindowInitOptions = new NativeWindowInitOptions();
        super(options);
        this.stage.align = StageAlign.TOP_LEFT;
        this.stage.scaleMode = StageScaleMode.NO_SCALE;
        this.visible = true;
        this.stage.addEventListener(MouseEvent.MOUSE_DOWN, onResizeCommand);
    }

    private function onResizeCommand(event:MouseEvent):void{
        var resizeFrom:String = "";
        if(event.localY < this.height * .33){resizeFrom = "T";}
        else if(event.localY > this.height * .66){resizeFrom = "B";}
        if(event.localX < this.width * .33){resizeFrom += "L";}
        else if(event.localX > this.width * .66){resizeFrom += "R";}
        
        this.startResize(resizeFrom);
    }    
}
Event Detail
activate Event
Event Object Type: flash.events.Event
Event.type property = flash.events.Event.ACTIVATE

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

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

Note: This event does not go through a "capture phase" and is dispatched directly to the target, 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.
close Event  
Event Object Type: flash.events.Event
Event.type property = flash.events.Event.CLOSE

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
Event.type property = flash.events.Event.CLOSING

Dispatched by this NativeWindow object immediately before the window is to be closed. This event can be cancelled 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.

Example

The following example :
deactivate Event  
Event Object Type: flash.events.Event
Event.type property = flash.events.Event.DEACTIVATE

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 does not go through a "capture phase" and is dispatched directly to the target, 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.
displayStateChange Event  
Event Object Type: flash.events.NativeWindowDisplayStateEvent
NativeWindowDisplayStateEvent.type property = flash.events.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGE

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

Defines the value of the type property of a displayStateChange event object. This event has the following properties:
PropertiesValues
afterStatethe old display state of the window.
beforeStatethe new display state of the window.
targetThe NativeWindow 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
NativeWindowDisplayStateEvent.type property = flash.events.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING

Dispatched by this NativeWindow object immediately before the window changes displayState. This event can be cancelled to prevent the change.

Defines the value of the type property of a displayStateChanging event object. This event has the following properties:
PropertiesValues
afterStatethe display state of the window before the pending change.
beforeStatethe display state of the window after the pending change.
targetThe NativeWindow 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 change.

Example

The following example demonstrates how to cancel a "displayStateChange" 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();
  }
}
move Event  
Event Object Type: flash.events.NativeWindowBoundsEvent
NativeWindowBoundsEvent.type property = flash.events.NativeWindowBoundsEvent.MOVE

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 in the handler functions for both the moving and move events of a NativeWindow. This may occur, for example, if both handler functions throw an error. If it does occur, the second dialog opened will not register mouse clicks and must be dismissed 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 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
NativeWindowBoundsEvent.type property = flash.events.NativeWindowBoundsEvent.MOVING

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

Note: Avoid actions that may open simultaneous operating system dialogs in the handler functions for both the moving and move events of a NativeWindow. This may occur, for example, if both handler functions throw an error. If it does occur, the second dialog opened will not register mouse clicks and must be dismissed 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 that has just changed state.
resize Event  
Event Object Type: flash.events.NativeWindowBoundsEvent
NativeWindowBoundsEvent.type property = flash.events.NativeWindowBoundsEvent.RESIZE

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 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
NativeWindowBoundsEvent.type property = flash.events.NativeWindowBoundsEvent.RESIZING

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

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();
  }
}




 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/labs/air/1/aslr/flash/display/NativeWindow.html