mx.core

# IWindow - AS3 Flex

Package | mx.core
Interface | public interface IWindow
Implementors | Window, Window, WindowedApplication, WindowedApplication

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

The IWindow interface defines the API for components that serve as top-level containers in Flex-based AIR applications (containers that represent operating system windows).

Public Properties

| Property | Defined By
--- | --- | ---
|  | maximizable : Boolean [read-only] Specifies whether the window can be maximized. | IWindow
|  | minimizable : Boolean [read-only] Specifies whether the window can be minimized. | IWindow
|  | nativeWindow : NativeWindow [read-only] The underlying NativeWindow that the Window component uses. | IWindow
|  | resizable : Boolean [read-only] Specifies whether the window can be resized. | IWindow
|  | status : String The string that appears in the status bar, if it is visible. | IWindow
|  | systemChrome : String [read-only] Specifies the type of system chrome (if any) the window has. | IWindow
|  | title : String The title text that appears in the window title bar and the taskbar. | IWindow
|  | titleIcon : Class The Class (usually an image) used to draw the title bar icon. | IWindow
|  | transparent : Boolean [read-only] Specifies whether the window is transparent. | IWindow
|  | type : String [read-only] Specifies the type of NativeWindow that this component represents. | IWindow
|  | visible : Boolean [read-only] Controls the window's visibility. | IWindow

Public Methods

| Method | Defined By
--- | --- | ---
|  | close():void Closes the window. | IWindow
|  | maximize():void Maximizes the window, or does nothing if it's already maximized. | IWindow
|  | minimize():void Minimizes the window. | IWindow
|  | restore():void Restores the window (unmaximizes it if it's maximized, or unminimizes it if it's minimized). | IWindow

Property Detail

### maximizable

property

`maximizable:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

Specifies whether the window can be maximized.

Implementation
`public function get maximizable():Boolean`

### minimizable

property

`minimizable:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

Specifies whether the window can be minimized.

Implementation
`public function get minimizable():Boolean`

### nativeWindow

property

`nativeWindow:NativeWindow` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

The underlying NativeWindow that the Window component uses.

Implementation
`public function get nativeWindow():NativeWindow`

### resizable

property

`resizable:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

Specifies whether the window can be resized.

Implementation
`public function get resizable():Boolean`

### status

property

`status:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

The string that appears in the status bar, if it is visible.

Implementation
`public function get status():String`
`public function set status(value:String):void`

### systemChrome

property

`systemChrome:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

Specifies the type of system chrome (if any) the window has. The set of possible values is defined by the constants in the NativeWindowSystemChrome class.

Implementation
`public function get systemChrome():String`

Related API Elements

flash.display.NativeWindowSystemChrome

### title

property

`title:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

The title text that appears in the window title bar and the taskbar.

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

### titleIcon

property

`titleIcon:Class`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

The Class (usually an image) used to draw the title bar icon.

Implementation
`public function get titleIcon():Class`
`public function set titleIcon(value:Class):void`

### transparent

property

`transparent:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

Specifies whether the window is transparent.

Implementation
`public function get transparent():Boolean`

### type

property

`type:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

Specifies the type of NativeWindow that this component represents. The set of possible values is defined by the constants in the NativeWindowType class.

Implementation
`public function get type():String`

Related API Elements

flash.display.NativeWindowType

### visible

property

`visible:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

Controls the window's visibility.

Implementation
`public function get visible():Boolean`
Method Detail

### close

()
method

`public function close():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

Closes the window.

### maximize

()
method

`public function maximize():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

Maximizes the window, or does nothing if it's already maximized.

### minimize

()
method

`public function minimize():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

Minimizes the window.

### restore

()
method

`public function restore():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | AIR 1.1

Restores the window (unmaximizes it if it's maximized, or unminimizes it if it's minimized).

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00