ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flash.display 

NativeWindowInitOptions  - AS3

Packageflash.display
Classpublic class NativeWindowInitOptions
InheritanceNativeWindowInitOptions Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The NativeWindowInitOptions class defines the initialization options used to construct a new NativeWindow instance.

The properties defined in the initialization options cannot be changed after a window is created.

Note: For the initial application window created automatically by AIR, all of these properties (except type) are set in the application descriptor. The initial window is always type NativeWindowType.NORMAL.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
      maximizable : Boolean
Specifies whether the window can be maximized by the user.
NativeWindowInitOptions
      minimizable : Boolean
Specifies whether the window can be minimized by the user.
NativeWindowInitOptions
      owner : NativeWindow
Specifies the NativeWindow object that should own any windows created with this NativeWindowInitOptions.
NativeWindowInitOptions
      renderMode : String
Specifies the render mode of the NativeWindow object created with this NativeWindowInitOptions.
NativeWindowInitOptions
      resizable : Boolean
Specifies whether the window can be resized by the user.
NativeWindowInitOptions
      systemChrome : String
Specifies whether system chrome is provided for the window.
NativeWindowInitOptions
      transparent : Boolean
Specifies whether the window supports transparency and alpha blending against the desktop.
NativeWindowInitOptions
      type : String
Specifies the type of the window to be created.
NativeWindowInitOptions
Public Methods
 MethodDefined By
  
Creates a new NativeWindowInitOptions object.
NativeWindowInitOptions
 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
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 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
Property Detail
    

maximizable

property
maximizable:Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Specifies whether the window can be maximized by the user.

For windows with system chrome, this setting will affect the appearance of the window maximize button. It will also affect other parts of the system-managed user interface, such as the window menu on Microsoft Windows.

When set to false, the window cannot be maximized by the user. Calling the NativeWindow maximize() method directly will maximize the window.

OS behavior notes:

  • On operating systems, such as Mac OS X, in which maximizing a window does not also prevent resizing, both maximizable and resizable must be set to false to prevent the window from being zoomed or resized.
  • Some Linux window managers allow windows to be maximized by the user even when the maximizable property is set to false.

The default value is true.



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

Related API Elements

    

minimizable

property 
minimizable:Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Specifies whether the window can be minimized by the user.

For windows with system chrome, this setting will affect the appearance of the window minimize button. It will also affect other parts of the system-managed user interface, such as the window menu on Microsoft Windows.

When set to false, the window cannot be minimized by the user. Calling the NativeWindow minimize() method directly will minimize the window.

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

The default value is true.



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

Related API Elements

    

owner

property 
owner:NativeWindow

Language Version: ActionScript 3.0
Runtime Versions: AIR 2.6

Specifies the NativeWindow object that should own any windows created with this NativeWindowInitOptions.

When a window has an owner, that window is always displayed in front of its owner, is minimized and hidden along with its owner, and closes when its owner closes.

The default value is null.



Implementation
    public function get owner():NativeWindow
    public function set owner(value:NativeWindow):void

Related API Elements

    

renderMode

property 
renderMode:String

Language Version: ActionScript 3.0
Runtime Versions: AIR 3.0

Specifies the render mode of the NativeWindow object created with this NativeWindowInitOptions.

Constants for the valid values of this property are defined in the NativeWindowRenderMode class

If not specified, the default value for renderMode is NativeWindowRenderMode.AUTO.

The default value is NativeWindowRenderMode.AUTO.



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

Related API Elements

    

resizable

property 
resizable:Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Specifies whether the window can be resized by the user.

When set to false, the window cannot be resized by the user using system chrome. Calling the NativeWindow startResize() method in response to a mouse event will allow the user to resize the window. Setting the window bounds directly will also change the window size.

OS behavior notes:

  • On operating systems, such as Mac OS X, in which maximizing windows is a resizing operation, both maximizable and resizable must be set to false to prevent the window from being zoomed or resized.
  • Some Linux window managers allow windows to be resized by the user even when the resizable property is set to false.

The default value is true.



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

Related API Elements

    

systemChrome

property 
systemChrome:String

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Specifies whether system chrome is provided for the window.

Chrome refers to the window controls that allow a user to control the desktop properties of a window. System chrome uses the standard controls for the desktop environment in which the AIR application is run and conforms to the standard look-and-feel of the native operating system.

To use chrome provided by a framework (such as Flex), or to provide your own window chrome, set systemChrome to NativeWindowSystemChrome.NONE.

Constants for the valid values of this property are defined in the NativeWindowSystemChrome class:

  • NativeWindowSystemChrome.NONE
  • NativeWindowSystemChrome.STANDARD

If not specified, the default value for systemChrome is NativeWindowSystemChrome.STANDARD.

Setting the transparent property to true for a window with system chrome is not supported.

The default value is NativeWindowSystemChrome.STANDARD.



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

Related API Elements

    

transparent

property 
transparent:Boolean

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Specifies whether the window supports transparency and alpha blending against the desktop.

If true, the window display is composited against the desktop. Areas of the window not covered by a display object, or covered by display objects with an alpha setting near zero, are effectively invisible and will not intercept mouse events (which will be received by the desktop object below the window). The alpha value at which an object will no longer intercepting mouse events varies between about .06 and .01, depending on the operating system.

Setting the transparent property to true for a window with system chrome is not supported.

Note: Not all Linux window managers support transparency. On such systems, transparent areas of a window are composited against black.

The default value is false.



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

type

property 
type:String

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Specifies the type of the window to be created.

Constants for the valid values of this property are defined in the NativeWindowType class:

  • NativeWindowType.NORMAL — A typical window. Normal windows use full-size chrome and appear on the Windows or Linux task bar.
  • NativeWindowType.UTILITY — A tool palette. Utility windows use a slimmer version of the system chrome and do not appear on the Windows task bar.
  • NativeWindowType.LIGHTWEIGHT — lightweight windows cannot have system chrome and do not appear on the Windows or Linux task bar. In addition, lightweight windows do not have the System (Alt-Space) menu on Windows. Lightweight windows are suitable for notification bubbles and controls such as combo-boxes that open a short-lived display area. When the lightweight type is used, systemChrome must be set to NativeWindowSystemChrome.NONE.

If not specified, the default value for type is NativeWindowType.NORMAL.

The default value is NativeWindowType.NORMAL.



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

Related API Elements

Constructor Detail
    

NativeWindowInitOptions

()Constructor
public function NativeWindowInitOptions()

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Creates a new NativeWindowInitOptions object.

The default values of the newly created object are:

  • systemChrome = NativeWindowSystemChrome.STANDARD
  • type = NativeWindowType.NORMAL
  • transparent = false
  • owner = null
  • resizable = true
  • maximizable = true
  • minimizable = true