Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.core 
Window 
Packagemx.core
Classpublic class Window
InheritanceWindow Inheritance LayoutContainer Inheritance Container Inheritance UIComponent Inheritance FlexSprite Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IWindow

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1


Starting with Flex 4.0, Adobe recommends that you use the spark.components.Window class as an alternative to this class.

The Window is a top-level container for additional windows in an AIR desktop application.

The Window container is a special kind of container in the sense that it cannot be used within other layout containers. An mx:Window component must be the top-level component in its MXML document.

The easiest way to use a Window component to define a native window is to create an MXML document with an <mx:Window> tag as the top-level tag in the document. You use the Window component just as you do any other container, including specifying the layout type, defining child controls, and so forth. Like any other custom MXML component, when your application is compiled your MXML document is compiled into a custom class that is a subclass of the Window component.

In your application code, to make an instance of your Window subclass appear on the screen you first create an instance of the class in code (by defining a variable and calling the new MyWindowClass() constructor. Next you set any properties you wish to specify for the new window. Finally you call your Window component's open() method to open the window on the screen.

Note that several of the Window class's properties can only be set before calling the open() method to open the window. Once the underlying NativeWindow is created, these initialization properties can be read but cannot be changed. This restriction applies to the following properties:

  • maximizable
  • minimizable
  • resizable
  • systemChrome
  • transparent
  • type

MXML SyntaxexpandedHide MXML Syntax

The <mx:Window> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

  <mx:Window
    Properties
    alwaysInFront="false"
    height="100"
    maxHeight="2880 less the height of the system chrome"
    maximizable="true"
    maxWidth="2880 less the width of the system chrome"
    menu="null"
    minHeight="dependent on the operating system and the AIR systemChrome setting"
    minimizable="true"
    minWidth="dependent on the operating system and the AIR systemChrome setting"
    resizable="true"
    showGripper="true"
    showStatusBar="true"
    showTitleBar="true"
    status=""
    statusBarFactory="mx.core.ClassFactory"
    systemChrome="standard"
    title=""
    titleBarFactory="mx.core.ClassFactory"
    titleIcon="null"
    transparent="false"
    type="normal"
    visible="true"
    width="100"
 
    Styles
    buttonAlignment="auto"
    buttonPadding="2"
    closeButtonSkin="mx.skins.halo.windowCloseButtonSkin"
    gripperPadding="3"
    gripperStyleName="gripperStyle"
    headerHeight="undefined"
    maximizeButtonSkin="mx.skins.halo.WindowMaximizeButtonSkin"
    minimizeButtonSkin="mx.skins.halo.WindowMinimizeButtonSkin"
    restoreButtonSkin="mx.skins.halo.WindowRestoreButtonSkin"
    showFlexChrome="true"
    statusBarBackgroundColor="0xC0C0C0"
    statusBarBackgroundSkin="mx.skins.halo.StatusBarBackgroundSkin"
    statusTextStyleName="undefined"
    titleAlignment="auto"
    titleBarBackgroundSkin="mx.skins.halo.ApplicationTitleBarBackgroundSkin"
    titleBarButtonPadding="5"
    titleBarColors="[ 0x000000, 0x000000 ]"
    titleTextStyleName="undefined"
 
    Effects
    closeEffect="No default"
    minimizeEffect="No default"
    unminimizeEffect="No default"
 
    Events
    applicationActivate="No default"
    applicationDeactivate="No default"
    closing="No default"
    displayStateChange="No default"
    displayStateChanging="No default"
    moving="No default"
    networkChange="No default"
    resizing="No default"
    windowComplete="No default"
    windowMove="No default"
    windowResize="No default"
  />
  

See also



Public Properties
 PropertyDefined By
 InheritedaccessibilityDescription : String
A convenience accessor for the description property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityEnabled : Boolean
A convenience accessor for the silent property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.
InteractiveObject
 InheritedaccessibilityName : String
A convenience accessor for the name property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 InheritedaccessibilityShortcut : String
A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedactiveEffects : Array
[read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
  AIR-only alwaysInFront : Boolean
Determines whether the underlying NativeWindow is always in front of other windows (including those of other applications).
Window
 InheritedautoLayout : Boolean
If true, measurement and layout are done when the position or size of a child is changed.
Container
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationEnabled : Boolean
[read-only] True if this component is enabled for automation, false otherwise.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIComponent
 InheritedautomationOwner : DisplayObjectContainer
[read-only] The owner of this component for automation purposes.
UIComponent
 InheritedautomationParent : DisplayObjectContainer
[read-only] The parent of this component for automation purposes.
UIComponent
 InheritedautomationTabularData : Object
[read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIComponent
 InheritedautomationValue : Array
[read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.
UIComponent
 InheritedautomationVisible : Boolean
[read-only] True if this component is visible for automation, false otherwise.
UIComponent
 Inheritedbaseline : Object
The vertical distance in pixels from the anchor target to the control's baseline position.
UIComponent
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedblendShader : Shader
[write-only] Sets a shader that is used for blending the foreground and background.
DisplayObject
 InheritedborderMetrics : EdgeMetrics
[read-only] Returns an EdgeMetrics object that has four properties: left, top, right, and bottom.
Container
 Inheritedbottom : Object
The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.
UIComponent
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the display object.
DisplayObject
 InheritedAIR-only cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.
DisplayObject
 InheritedcacheHeuristic : Boolean
[write-only] Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
 InheritedchildDescriptors : Array
[read-only] Array of UIComponentDescriptor objects produced by the MXML compiler.
Container
 InheritedclassName : String
[read-only] The name of this instance's class, such as "Button".
UIComponent
 InheritedclipContent : Boolean
Whether to apply a clip mask if the positions and/or sizes of this container's children extend outside the borders of this container.
Container
  AIR-only closed : Boolean
[read-only] A flag indicating whether the window has been closed.
Window
 InheritedconstraintColumns : Array
An Array of ConstraintColumn instances that partition this container.
LayoutContainer
 InheritedconstraintRows : Array
An Array of ConstraintRow instances that partition this container.
LayoutContainer
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcontentMouseX : Number
[override] [read-only] Returns the x position of the mouse, in the content coordinate system.
Container
 InheritedcontentMouseY : Number
[override] [read-only] Returns the y position of the mouse, in the content coordinate system.
Container
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
  AIR-only controlBar : IUIComponent
The ApplicationControlBar for this Window.
Window
 InheritedcreatingContentPane : Boolean
Containers use an internal content pane to control scrolling.
Container
 InheritedcreationIndex : int
Deprecated: Deprecated
Specifies the order to instantiate and draw the children of the container.
Container
 InheritedcreationPolicy : String
The child creation policy for this MX Container.
Container
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
[read-only] Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
 Inheriteddata : Object
The data property lets you pass a value to the component when you use it in an item renderer or item editor.
Container
 InheriteddefaultButton : IFlexDisplayObject
The Button control designated as the default button for the container.
Container
 InheriteddeferredContentCreated : Boolean
[read-only] IDeferredContentOwner equivalent of processedDescriptors
Container
 Inheriteddepth : Number
Determines the order in which items inside of containers are rendered.
UIComponent
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 InheriteddesignLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual element.
UIComponent
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
[override] Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 InheriteddropTarget : DisplayObject
[read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.
Sprite
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
UIComponent
 InheritederrorString : String
The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails.
UIComponent
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
 InheritedflexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
 InheritedfocusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
UIComponent
 InheritedfocusManager : IFocusManager
Gets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusPane : Sprite
The focus pane associated with this object.
UIComponent
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
 InheritedhasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus.
UIComponent
 InheritedhasLayoutMatrix3D : Boolean
[read-only] Contians true if the element has 3D Matrix.
UIComponent
 Inheritedheight : Number
[override] Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
 InheritedhorizontalCenter : Object
The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.
UIComponent
 InheritedhorizontalLineScrollSize : Number
Number of pixels to move when the left- or right-arrow button in the horizontal scroll bar is pressed.
Container
 InheritedhorizontalPageScrollSize : Number
Number of pixels to move when the track in the horizontal scroll bar is pressed.
Container
 InheritedhorizontalScrollBar : ScrollBar
The horizontal scrollbar used in this container.
Container
 InheritedhorizontalScrollPolicy : String
Specifies whether the horizontal scroll bar is always present, always absent, or automatically added when needed.
Container
 InheritedhorizontalScrollPosition : Number
The current position of the horizontal scroll bar.
Container
 Inheritedid : String
ID of the component.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : Boolean
A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).
UIComponent
 InheritedinstanceIndex : int
[read-only] The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 Inheritedis3D : Boolean
[read-only] Contains true when the element is in 3D.
UIComponent
 InheritedisDocument : Boolean
[read-only] Contains true if this UIComponent instance is a document object.
UIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
 Inheritedlayout : String
Specifies the layout mechanism used for this application.
LayoutContainer
 InheritedlayoutMatrix3D : Matrix3D
[write-only] The transform matrix that is used to calculate a component's layout relative to its siblings.
UIComponent
 Inheritedleft : Object
The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.
UIComponent
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
 InheritedmaintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the middle of its bounding box.
UIComponent
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
DisplayObject
 InheritedmaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedmaxHorizontalScrollPosition : Number
[read-only] The largest possible value for the horizontalScrollPosition property.
Container
  AIR-only maximizable : Boolean
Specifies whether the window can be maximized.
Window
 InheritedmaxVerticalScrollPosition : Number
[read-only] The largest possible value for the verticalScrollPosition property.
Container
 InheritedmaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
  AIR-only menu : FlexNativeMenu
The window menu for this window.
Window
 InheritedminHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
  AIR-only minimizable : Boolean
Specifies whether the window can be minimized.
Window
 InheritedminWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmoduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component.
UIComponent
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages.
InteractiveObject
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.
DisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
  AIR-only nativeWindow : NativeWindow
[read-only] The underlying NativeWindow that this Window component uses.
Window
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
 InheritednumAutomationChildren : int
[read-only] The number of automation children this container has.
UIComponent
 InheritednumChildren : int
[override] [read-only] Number of child components in this container.
Container
 InheritednumElements : int
[read-only] The number of visual elements in this container.
Container
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
UIComponent
 Inheritedparent : DisplayObjectContainer
[override] [read-only] The parent container or component for this component.
UIComponent
 InheritedparentApplication : Object
[read-only] A reference to the Application object that contains this UIComponent instance.
UIComponent
 InheritedparentDocument : Object
[read-only] A reference to the parent document object for this UIComponent.
UIComponent
 InheritedpercentHeight : Number
Specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedpostLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.
UIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrawChildren : IChildList
[read-only] A container typically contains child components, which can be enumerated using the Container.getChildAt() method and Container.numChildren property.
Container
 Inheritedrepeater : IRepeater
[read-only] A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
[read-only] The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : Array
An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent.
UIComponent
 Inheritedrepeaters : Array
An Array containing references to the Repeater objects in the parent document that produced this UIComponent.
UIComponent
  AIR-only resizable : Boolean
Specifies whether the window can be resized.
Window
 Inheritedright : Object
The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.
UIComponent
 Inheritedroot : DisplayObject
[read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.
DisplayObject
 Inheritedrotation : Number
[override] Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
UIComponent
 InheritedrotationX : Number
[override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationY : Number
[override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationZ : Number
[override] Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
 InheritedscaleX : Number
[override] Number that specifies the horizontal scaling factor.
UIComponent
 InheritedscaleY : Number
[override] Number that specifies the vertical scaling factor.
UIComponent
 InheritedscaleZ : Number
[override] Number that specifies the scaling factor along the z axis.
UIComponent
 Inheritedscreen : Rectangle
[read-only] Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the display object.
DisplayObject
  AIR-only showGripper : Boolean
If true, the gripper is visible.
Window
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
  AIR-only showStatusBar : Boolean
If true, the status bar is visible.
Window
  AIR-only showTitleBar : Boolean
If true, the window's title bar is visible.
Window
 InheritedsoundTransform : flash.media:SoundTransform
Controls sound within this sprite.
Sprite
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
  AIR-only status : String
The string that appears in the status bar, if it is visible.
Window
  AIR-only statusBar : UIComponent
[read-only] The UIComponent that displays the status bar.
Window
  AIR-only statusBarFactory : IFactory
The IFactory that creates an instance to use as the status bar.
Window
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleManager : IStyleManager2
[read-only] Returns the StyleManager instance used by this component.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedstyleParent : IAdvancedStyleClient
[read-only] A component's parent is used to evaluate descendant selectors.
UIComponent
  AIR-only systemChrome : String
Specifies the type of system chrome (if any) the window has.
Window
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus via the TAB key This is similar to the tabEnabled property used by the Flash Player. This is usually true for components that handle keyboard input, but some components in controlbars have them set to false because they should not steal focus from another component like an editor.
UIComponent
 InheritedtextSnapshot : flash.text:TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
  AIR-only title : String
The title text that appears in the window title bar and the taskbar.
Window
  AIR-only titleBar : UIComponent
[read-only] The UIComponent that displays the title bar.
Window
  AIR-only titleBarFactory : IFactory
The IFactory that creates an instance to use as the title bar.
Window
  AIR-only titleIcon : Class
The Class (usually an image) used to draw the title bar icon.
Window
 Inheritedtop : Object
The vertical distance in pixels from the top edge of the component to the anchor target's top edge.
UIComponent
 Inheritedtransform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
 InheritedtransformX : Number
Sets the x coordinate for the transform center of the component.
UIComponent
 InheritedtransformY : Number
Sets the y coordinate for the transform center of the component.
UIComponent
 InheritedtransformZ : Number
Sets the z coordinate for the transform center of the component.
UIComponent
 Inheritedtransitions : Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
UIComponent
  AIR-only transparent : Boolean
Specifies whether the window is transparent.
Window
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIComponent
  AIR-only type : String
Specifies the type of NativeWindow that this component represents.
Window
 Inheriteduid : String
A unique identifier for the object.
UIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIComponent
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true.
Sprite
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 InheritedverticalCenter : Object
The vertical distance in pixels from the center of the component to the center of the anchor target's content area.
UIComponent
 InheritedverticalLineScrollSize : Number
Number of pixels to scroll when the up- or down-arrow button in the vertical scroll bar is pressed, or when you scroll by using the mouse wheel.
Container
 InheritedverticalPageScrollSize : Number
Number of pixels to scroll when the track in the vertical scroll bar is pressed.
Container
 InheritedverticalScrollBar : ScrollBar
The vertical scrollbar used in this container.
Container
 InheritedverticalScrollPolicy : String
Specifies whether the vertical scroll bar is always present, always absent, or automatically added when needed.
Container
 InheritedverticalScrollPosition : Number
The current position of the vertical scroll bar.
Container
 InheritedviewMetrics : EdgeMetrics
[read-only] Returns an object that has four properties: left, top, right, and bottom.
Container
 InheritedviewMetricsAndPadding : EdgeMetrics
[read-only] Returns an object that has four properties: left, top, right, and bottom.
Container
 Inheritedvisible : Boolean
[override] Whether or not the display object is visible.
UIComponent
 Inheritedwidth : Number
[override] Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
 Inheritedz : Number
[override] Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
UIComponent
Protected Properties
 PropertyDefined By
 InheritedactualCreationPolicy : String
The creation policy of this container.
Container
 InheritedboxLayoutClass : Class
The mx.containers.utilityClasses.Layout subclass that is doing the layout
LayoutContainer
 InheritedcanvasLayoutClass : Class
The mx.containers.utilityClasses.Layout subclass that is doing the layout
LayoutContainer
 InheritedcurrentCSSState : String
[read-only] The state to be used when matching CSS pseudo-selectors.
UIComponent
 InheritedhasComplexLayoutMatrix : Boolean
[read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties.
UIComponent
 InheritedresourceManager : IResourceManager
[read-only] A reference to the object which manages all of the application's localized resources.
UIComponent
  AIR-only statusBarStyleFilters : Object
[read-only] Set of styles to pass from the window to the status bar.
Window
  AIR-only titleBarStyleFilters : Object
[read-only] Set of styles to pass from the Window to the titleBar.
Window
 InheritedunscaledHeight : Number
[read-only] A convenience method for determining the unscaled height of the component.
UIComponent
 InheritedunscaledWidth : Number
[read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList().
UIComponent
Public Methods
 MethodDefined By
  
AIR-only Window()
Constructor.
Window
  
Activates the underlying NativeWindow (even if this Window's application is not currently active).
Window
 Inherited
[override] Adds a child DisplayObject to this Container.
Container
 Inherited
[override] Adds a child DisplayObject to this Container.
Container
 Inherited
Adds a visual element to this container.
Container
 Inherited
Adds a visual element to this container.
Container
 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
 Inherited
Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.
DisplayObjectContainer
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
 Inherited
Deletes a style property from this component instance.
UIComponent
  
Closes the window.
Window
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
[override] Converts a Point object from content coordinates to global coordinates.
Container
 Inherited
[override] Converts a Point object from content to local coordinates.
Container
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Given a single UIComponentDescriptor, create the corresponding component and add the component as a child of this Container.
Container
 Inherited
Iterate through the Array of childDescriptors, and call the createComponentFromDescriptor() method for each one.
Container
 Inherited
Performs the equivalent action of calling the createComponentsFromDescriptors(true) method for containers that implement the IDeferredContentOwner interface to support deferred instantiation.
Container
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
[override] Dispatches an event into the event flow.
UIComponent
 Inherited
Shows or hides the focus indicator around this component.
UIComponent
 Inherited
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object.
UIComponent
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
Ends all currently playing effects on the component.
UIComponent
 Inherited
executeBindings(recurse:Boolean = false):void
[override] Executes all the data bindings on this Container.
Container
 Inherited
Executes the bindings into this Container's child UIComponent objects.
Container
 Inherited
Called after printing is complete.
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
Provides the automation object list .
UIComponent
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.
DisplayObject
 Inherited
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
[override] Gets the nth child component object.
Container
 Inherited
[override] Returns the child whose name property is the specified String.
Container
 Inherited
[override] Gets the zero-based index of a specific child.
Container
 Inherited
Returns an Array of DisplayObject objects consisting of the content children of the container.
Container
 Inherited
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
UIComponent
 Inherited
Returns the visual element at the specified index.
Container
 Inherited
Returns the index position of a visual element.
Container
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIComponent
 Inherited
Gets the object that currently has focus.
UIComponent
 Inherited
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
UIComponent
 Inherited
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
UIComponent
 Inherited
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
UIComponent
 Inherited
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
UIComponent
 Inherited
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
UIComponent
 Inherited
Returns the layout transform Matrix3D for this element.
UIComponent
 Inherited
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
UIComponent
 Inherited
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
UIComponent
 Inherited
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
UIComponent
 Inherited
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
UIComponent
 Inherited
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
UIComponent
 Inherited
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
UIComponent
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.
DisplayObject
 Inherited
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated.
UIComponent
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIComponent
  
[static] Returns the Window to which a component is parented.
Window
 Inherited
[override] Converts a Point object from global to content coordinates.
Container
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.
DisplayObject
 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
Determines whether the specified state has been defined on this UIComponent.
UIComponent
 Inherited
Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.
DisplayObject
 Inherited
Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.
UIComponent
 Inherited
Initializes the internal structure of this component.
UIComponent
 Inherited
Initializes various properties which keep track of repeated instances of this component.
UIComponent
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
Called by a component's items to indicate that their depth property has changed.
UIComponent
 Inherited
An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.
UIComponent
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
DisplayObject
 Inherited
[override] Converts a Point object from local to content coordinates.
Container
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
Returns true if cssState matches currentCSSState.
UIComponent
 Inherited
Determines whether this instance is the same as, or is a subclass of, the given type.
UIComponent
  
Maximizes the window, or does nothing if it's already maximized.
Window
 Inherited
Measures the specified HTML text, which can contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
Measures the specified text, assuming that it is displayed in a single-line UITextField (or UIFTETextField) using a UITextFormat determined by the styles of this UIComponent.
UIComponent
  
Minimizes the window.
Window
 Inherited
Moves the component to a specified position within its parent.
UIComponent
 Inherited
Propagates style changes to the children.
UIComponent
  
AIR-only open(openWindowActive:Boolean = true):void
Creates the underlying NativeWindow and opens it.
Window
  
Orders the window just behind another.
Window
  
Orders the window just in front of another.
Window
  
Orders the window behind all others in the same application.
Window
  
Orders the window in front of all others in the same application.
Window
 Inherited
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well.
UIComponent
 Inherited
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
Removes all children from the child list of this container.
Container
 Inherited
Removes all visual elements from the container.
Container
 Inherited
[override] Removes a child DisplayObject from the child list of this Container.
Container
 Inherited
[override] Removes a child DisplayObject from the child list of this Container at the specified index.
Container
 Inherited
Removes the specified visual element from the child list of this container.
Container
 Inherited
Removes a visual element from the specified index position in the container.
Container
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Replays the specified event.
UIComponent
 Inherited
Resolves a child by using the id provided.
UIComponent
  
Restores the window (unmaximizes it if it's maximized, or unminimizes it if it's minimized).
Window
 Inherited
[static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().
UIComponent
 Inherited
Sizes the object.
UIComponent
 Inherited
[override] Sets the index of a particular child.
Container
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
Changes the position of an existing visual element in the visual container.
Container
 Inherited
Sets the focus to this component.
UIComponent
 Inherited
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
UIComponent
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element.
UIComponent
 Inherited
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite on a touch-enabled device.
Sprite
 Inherited
Ends the startDrag() method.
Sprite
 Inherited
stopTouchDrag(touchPointID:int):void
Ends the startTouchDrag() method, for use with touch-enabled devices.
Sprite
 Inherited
Detects changes to style properties.
UIComponent
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
Swaps the z-order (front-to-back order) of the two specified child objects.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
DisplayObjectContainer
 Inherited
Swaps the index of the two specified visual elements.
Container
 Inherited
swapElementsAt(index1:int, index2:int):void
Swaps the visual elements at the two specified index positions in the container.
Container
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
 Inherited
transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.
UIComponent
 Inherited
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates.
UIComponent
 Inherited
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
 Inherited
validateSize(recursive:Boolean = false):void
Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.
UIComponent
 Inherited
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.
UIComponent
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
Adjust the focus rectangle.
UIComponent
 Inherited
Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.
UIComponent
 Inherited
[override] Used internally by the Dissolve Effect to add the overlay to the chrome of a container.
Container
 Inherited
Determines if the call to the measure() method can be skipped.
UIComponent
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
Processes the properties set on the component.
UIComponent
 Inherited
Creates the container's border skin if it is needed and does not already exist.
Container
 Inherited
Create child objects of the component.
UIComponent
 Inherited
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
Creates the object using a given moduleFactory.
UIComponent
 Inherited
dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent when a property is updated.
UIComponent
 Inherited
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.
UIComponent
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).
UIComponent
 Inherited
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
The event handler called for a keyDown event.
UIComponent
 Inherited
The event handler called for a keyUp event.
UIComponent
 Inherited
layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
Respond to size changes by setting the positions and sizes of this container's borders.
Container
 Inherited
Calculates the default size, and optionally the default minimum size, of the component.
UIComponent
  
Manages mouse down events on the window border.
Window
 Inherited
This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.
UIComponent
 Inherited
Positions the container's content area relative to the viewable area based on the horizontalScrollPosition and verticalScrollPosition properties.
Container
 Inherited
setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction.
UIComponent
 Inherited
stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether state-specific styles apply to this component.
UIComponent
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override] Respond to size changes by setting the positions and sizes of this container's children.
Container
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 InheritedDispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.UIComponent
 InheritedDispatched when a display object is added to the display list.DisplayObject
 InheritedDispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
  Dispatched when this application gets activated.Window
  Dispatched when this application gets deactivated.Window
 InheritedDispatched after a child has been added to a container.Container
 InheritedDispatched after the index (among the container children) of a container child changes.Container
 InheritedDispatched before a child of a container is removed.Container
 InheritedDispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 InheritedDispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
  Dispatched after the window has been closed.Window
  Dispatched before the window closes.Window
 InheritedDispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.InteractiveObject
 InheritedDispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 InheritedDispatched after the view state has changed.UIComponent
 InheritedDispatched after the currentState property changes, but before the view state changes.UIComponent
 InheritedDispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.InteractiveObject
 InheritedDispatched when the data property changes.Container
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
  Dispatched after the display state changes to minimize, maximize or restore.Window
  Dispatched before the display state changes to minimize, maximize or restore.Window
 InheritedDispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.InteractiveObject
 InheritedDispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.UIComponent
 InheritedDispatched by the drop target when the user releases the mouse over it.UIComponent
 InheritedDispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 InheritedDispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 InheritedDispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 InheritedDispatched by the drag initiator when starting a drag operation.UIComponent
 InheritedDispatched after an effect ends.UIComponent
 InheritedDispatched just before an effect starts.UIComponent
 InheritedDispatched after an effect is stopped, which happens only by a call to stop() on the effect.UIComponent
 Inherited[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
 InheritedDispatched after the component has entered a view state.UIComponent
 Inherited[broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 InheritedDispatched just before the component exits a view state.UIComponent
 InheritedDispatched after a display object gains focus.InteractiveObject
 InheritedDispatched after a display object loses focus.InteractiveObject
 Inherited[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 InheritedDispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a fingers from left to right over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when an object's state changes from visible to invisible.UIComponent
 InheritedThis event is dispatched to any client app that supports inline input with an IMEInteractiveObject
 InheritedDispatched when the component has finished its construction and has all initialization properties set.UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation failed.UIComponent
 InheritedDispatched when the user presses a key.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 InheritedDispatched when the user releases a key.InteractiveObject
 InheritedDispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 InheritedDispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 InheritedDispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 InheritedDispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 InheritedDispatched when the object has moved.UIComponent
  Dispatched before the window moves, and while the window is being dragged.Window
 InheritedDispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 InheritedDispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject continually while a drag gesture remains within its boundary.InteractiveObject
 InheritedDispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
  Dispatched when the computer connects to or disconnects from the network.Window
 InheritedDispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.InteractiveObject
 InheritedDispatched at the beginning of the component initialization sequence.UIComponent
 InheritedDispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.UIComponent
 InheritedDispatched when a display object is about to be removed from the display list.DisplayObject
 InheritedDispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited[broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 InheritedDispatched when the component is resized.UIComponent
  Dispatched before the underlying NativeWindow is resized, or while the Window object boundaries are being dragged.Window
 InheritedDispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user manually scrolls the container.Container
 InheritedDispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.InteractiveObject
 InheritedDispatched when an object's state changes from invisible to visible.UIComponent
 InheritedDispatched when the value of the object's tabChildren flag changes.InteractiveObject
 InheritedDispatched when the object's tabEnabled flag changes.InteractiveObject
 InheritedDispatched when the value of the object's tabIndex property changes.InteractiveObject
 InheritedDispatched when a user enters one or more characters of text.InteractiveObject
 InheritedDispatched by the component when it is time to create a ToolTip.UIComponent
 InheritedDispatched by the component when its ToolTip has been hidden and is to be discarded soon.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be hidden.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be shown.UIComponent
 InheritedDispatched by the component when its ToolTip has been shown.UIComponent
 InheritedDispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 InheritedDispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact with a touch-enabled device (such as drags a finger across a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outisde the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 InheritedDispatched when values are changed programmatically or by user interaction.UIComponent
  Dispatched after the window has been activated.Window
  Dispatched when the Window completes its initial layout and opens the underlying NativeWindow.Window
  Dispatched after the window has been deactivated.Window
  Dispatched after the window moves.Window
  Dispatched after the underlying NativeWindow is resized.Window
Styles

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles
 Style Description Defined By
 InheritedType: String CSS Inheritance: no
If a background image is specified, this style specifies whether it is fixed with regard to the viewport ("fixed") or scrolls along with the content ("scroll").
Container
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the top edge of the content area to the control's baseline position.
UIComponent
 InheritedType: Class CSS Inheritance: no
The border skin class of the component.
Container
 InheritedType: String CSS Inheritance: no
Bounding box style.
Container
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.
UIComponent
  
buttonAlignment
Type: String CSS Inheritance: yes
Position of buttons in title bar. Possible values: "left", "right", "auto".

A value of "left" means the buttons are aligned at the left of the title bar. A value of "right" means the buttons are aligned at the right of the title bar. A value of "auto" means the buttons are aligned at the left of the title bar on Mac OS X and on the right on Windows.

The default value is "auto".
Window
  
buttonPadding
Type: Number CSS Inheritance: yes
Defines the distance between the titleBar buttons. The default value is 2.
Window
  
closeButtonSkin
Type: Class CSS Inheritance: no
Skin for close button when using Flex chrome. The default value is mx.skins.halo.WindowCloseButtonSkin.
Window
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of text in the component, including the component label.
Container
 InheritedType: String CSS Inheritance: yes
The directionality of the text displayed by the component.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of text in the component if it is disabled.
Container
 InheritedType: Number CSS Inheritance: no
The alpha value for the overlay that is placed on top of the container when it is disabled.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
 InheritedType: String CSS Inheritance: no
Blend mode used by the focus rectangle.
UIComponent
 InheritedType: Class CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
 InheritedType: Number Format: Length CSS Inheritance: no
Thickness, in pixels, of the focus rectangle outline.
UIComponent
 InheritedType: String CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields.
Container
 InheritedType: String CSS Inheritance: yes
Name of the font to use.
Container
 InheritedType: String CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls.
Container
 InheritedType: Number CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls.
Container
 InheritedType: Number Format: Length CSS Inheritance: yes
Height of the text, in pixels.
Container
 InheritedType: String CSS Inheritance: yes
Determines whether the text is italic font.
Container
 InheritedType: Number CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls.
Container
 InheritedType: String CSS Inheritance: yes
Determines whether the text is boldface.
Container
  
gripperPadding
Type: Number Format: Length CSS Inheritance: no
The extra space around the gripper. The total area of the gripper plus the padding around the edges is the hit area for the gripper resizing. The default value is 3.
Window
  
gripperStyleName
Type: String CSS Inheritance: no
Style declaration for the skin of the gripper. The default value is "gripperStyle".
Window
  
headerHeight
Type: Number Format: Length CSS Inheritance: no
The explicit height of the header. If this style is not set, the header height is calculated from the largest of the text height, the button heights, and the icon height. The default value is undefined.
Window
 InheritedType: String CSS Inheritance: no
Horizontal alignment of children in the container.
LayoutContainer
 InheritedType: String CSS Inheritance: no
The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIComponent
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between children in the horizontal direction.
LayoutContainer
 InheritedType: String CSS Inheritance: no
The name of the horizontal scrollbar style.
Container
 InheritedType: Boolean CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false).
Container
 InheritedType: String CSS Inheritance: yes
Specifies the desired layout direction of a component.
UIComponent
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.
UIComponent
 InheritedType: Number CSS Inheritance: yes
The number of additional pixels to appear between each character.
Container
 InheritedType: String CSS Inheritance: yes
The locale of the text displayed by this component.
Container
  
maximizeButtonSkin
Type: Class CSS Inheritance: no
Skin for maximize button when using Flex chrome. The default value is mx.skins.halo.WindowMaximizeButtonSkin.
Window
  
minimizeButtonSkin
Type: Class CSS Inheritance: no
Skin for minimize button when using Flex chrome. The default value is mx.skins.halo.WindowMinimizeButtonSkin.
Window
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the bottom border and its content area.
LayoutContainer
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the component's left border and the left edge of its content area.
Container
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the component's right border and the right edge of its content area.
Container
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the top border and its content area.
LayoutContainer
  
restoreButtonSkin
Type: Class CSS Inheritance: no
Skin for restore button when using Flex chrome. This style is ignored for Mac OS X. The default value is mx.skins.halo.WindowRestoreButtonSkin.
Window
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.
UIComponent
  
showFlexChrome
Type: Boolean CSS Inheritance: no
Determines whether the window draws its own Flex Chrome or depends on the developer to draw chrome. Changing this style once the window is open has no effect. The default value is true.
Window
  
statusBarBackgroundColor
Type: uint Format: Color CSS Inheritance: yes
The colors used to draw the status bar. The default value is 0xC0C0C0.
Window
  
statusBarBackgroundSkin
Type: Class CSS Inheritance: yes
The status bar background skin. The default value is mx.skins.halo.StatusBarBackgroundSkin.
Window
  
statusTextStyleName
Type: String CSS Inheritance: yes
Style declaration for the status text. The default value is undefined.
Window
 InheritedType: String CSS Inheritance: yes
Alignment of text within a container.
Container
 InheritedType: String CSS Inheritance: yes
Determines whether the text is underlined.
Container
 InheritedType: Class CSS Inheritance: no
The class implementing IUITextField that is used by this component to render text.
Container
 InheritedType: Number Format: Length CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels.
Container
  
titleAlignment
Type: String CSS Inheritance: yes
Position of the title in title bar. The possible values are "left", "center", "auto"

A value of "left" means the title is aligned at the left of the title bar. A value of "center" means the title is aligned at the center of the title bar. A value of "auto" means the title is aligned at the left on Windows and at the center on Mac OS X.

The default value is "auto".
Window
  
titleBarBackgroundSkin
Type: Class CSS Inheritance: yes
The title background skin. The default value is mx.skins.halo.ApplicationTitleBarBackgroundSkin.
Window
  
titleBarButtonPadding
Type: Number CSS Inheritance: true
The distance between the furthest out title bar button and the edge of the title bar. The default value is 5.
Window
  
titleBarColors
Type: Array Format: Color CSS Inheritance: yes
An array of two colors used to draw the header. The first color is the top color. The second color is the bottom color. The default values are undefined, which makes the header background the same as the panel background. The default value is [ 0x000000, 0x000000 ].
Window
  
titleTextStyleName
Type: String CSS Inheritance: yes
The style name for the title text. The default value is undefined.
Window
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area.
UIComponent
 InheritedType: String CSS Inheritance: no
Vertical alignment of children in the container.
LayoutContainer
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the center of the component's content area to the center of the component.
UIComponent
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between children in the vertical direction.
LayoutContainer
 InheritedType: String CSS Inheritance: no
The name of the vertical scrollbar style.
Container
Spark Theme Styles
 Style Description Defined By
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Accent color used by component skins.
Container
 InheritedType: Number CSS Inheritance: no Theme: halo, spark
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style.
Container
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo, spark
Background color of a component.
Container
 InheritedType: Number CSS Inheritance: no Theme: spark
Alpha of the border.
Container
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo, spark
Color of the border.
Container
 InheritedType: Boolean CSS Inheritance: no Theme: spark
Visibility of the border.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
The main color for a component.
UIComponent
 InheritedType: Number CSS Inheritance: yes Theme: spark
The alpha of the content background for this component.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of the content area of the component.
Container
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo, spark
Radius of component corners.
Container
 InheritedType: Boolean CSS Inheritance: no Theme: spark
Boolean property that specifies whether the component has a visible drop shadow.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of focus ring when the component is in focus
Container
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of any symbol of a component.
Container
Halo Theme Styles
 Style Description Defined By
 InheritedType: Number CSS Inheritance: no Theme: halo, spark
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style.
Container
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo, spark
Background color of a component.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Background color of the component when it is disabled.
Container
 InheritedType: Object Format: File CSS Inheritance: no Theme: halo
Background image of a component.
Container
 InheritedType: String CSS Inheritance: no Theme: halo
Scales the image specified by backgroundImage to different percentage sizes.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Determines the color of a ProgressBar.
Container
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo, spark
Color of the border.
Container
 InheritedType: String CSS Inheritance: no Theme: halo
Bounding box sides.
Container
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo
Bounding box thickness.
Container
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo, spark
Radius of component corners.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Color of the drop shadow.
Container
 InheritedType: Boolean CSS Inheritance: no Theme: halo
Boolean property that specifies whether the component has a visible drop shadow.
Container
 InheritedType: String CSS Inheritance: no Theme: halo
Direction of the drop shadow.
Container
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo
Distance of the drop shadow.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Theme color of a component.
UIComponent
Effects
 Effect Description Defined By
 Inherited Triggering Event: added
Played when the component is added as a child to a Container.
UIComponent
  
closeEffect
Triggering Event: windowClose
Played when the window is closed.
Window
 Inherited Triggering Event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering Event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering Event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering Event: hide
Played when the component becomes invisible.
UIComponent
  
minimizeEffect
Triggering Event: windowMinimize
Played when the component is minimized.
Window
 Inherited Triggering Event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering Event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering Event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering Event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering Event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering Event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering Event: show
Played when the component becomes visible.
UIComponent
  
unminimizeEffect
Triggering Event: windowUnminimize
Played when the component is unminimized.
Window
Public Constants
 ConstantDefined By
 InheritedDEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
 InheritedDEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
Property Detail
AIR-only 

alwaysInFront

property
alwaysInFront:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Determines whether the underlying NativeWindow is always in front of other windows (including those of other applications). Setting this property sets the alwaysInFront property of the underlying NativeWindow. See the NativeWindow.alwaysInFront property description for details of how this affects window stacking order.



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

See also

AIR-only 

closed

property 
closed:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

A flag indicating whether the window has been closed.



Implementation
    public function get closed():Boolean
AIR-only 

controlBar

property 
public var controlBar:IUIComponent

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

The ApplicationControlBar for this Window.

The default value is null.

See also

AIR-only 

maximizable

property 
maximizable:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Specifies whether the window can be maximized. This property's value is read-only after the window has been opened.



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

menu

property 
menu:FlexNativeMenu

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

The window menu for this window. Some operating systems do not support window menus, in which case this property is ignored.



Implementation
    public function get menu():FlexNativeMenu
    public function set menu(value:FlexNativeMenu):void
AIR-only 

minimizable

property 
minimizable:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Specifies whether the window can be minimized. This property is read-only after the window has been opened.



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

nativeWindow

property 
nativeWindow:NativeWindow  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

The underlying NativeWindow that this Window component uses.



Implementation
    public function get nativeWindow():NativeWindow
AIR-only 

resizable

property 
resizable:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Specifies whether the window can be resized. This property is read-only after the window has been opened.



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

showGripper

property 
showGripper:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

If true, the gripper is visible.

On Mac OS X a window with systemChrome set to "standard" always has an operating system gripper, so this property is ignored in that case.

The default value is true.



Implementation
    public function get showGripper():Boolean
    public function set showGripper(value:Boolean):void
AIR-only 

showStatusBar

property 
showStatusBar:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

If true, the status bar is visible.

The default value is true.



Implementation
    public function get showStatusBar():Boolean
    public function set showStatusBar(value:Boolean):void
AIR-only 

showTitleBar

property 
showTitleBar:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

If true, the window's title bar is visible.

The default value is true.



Implementation
    public function get showTitleBar():Boolean
    public function set showTitleBar(value:Boolean):void
AIR-only 

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.

The default value is "".

This property can be used as the source for data binding. When this property is modified, it dispatches the statusChanged event.



Implementation
    public function get status():String
    public function set status(value:String):void
AIR-only 

statusBar

property 
statusBar:UIComponent  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

The UIComponent that displays the status bar.



Implementation
    public function get statusBar():UIComponent
AIR-only 

statusBarFactory

property 
statusBarFactory:IFactory

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

The IFactory that creates an instance to use as the status bar. The default value is an IFactory for StatusBar.

If you write a custom status bar class, it should expose a public property named status.

This property can be used as the source for data binding. When this property is modified, it dispatches the statusBarFactoryChanged event.



Implementation
    public function get statusBarFactory():IFactory
    public function set statusBarFactory(value:IFactory):void
AIR-only 

statusBarStyleFilters

property 
statusBarStyleFilters:Object  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Set of styles to pass from the window to the status bar.



Implementation
    protected function get statusBarStyleFilters():Object

See also

AIR-only 

systemChrome

property 
systemChrome:String

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.

This property is read-only once the window has been opened.

The default value is NativeWindowSystemChrome.STANDARD.



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

See also

AIR-only 

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.

The default value is "".

This property can be used as the source for data binding. When this property is modified, it dispatches the titleChanged event.



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

titleBar

property 
titleBar:UIComponent  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

The UIComponent that displays the title bar.



Implementation
    public function get titleBar():UIComponent
AIR-only 

titleBarFactory

property 
titleBarFactory:IFactory

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

The IFactory that creates an instance to use as the title bar. The default value is an IFactory for TitleBar.

If you write a custom title bar class, it should expose public properties named titleIcon and title.

This property can be used as the source for data binding. When this property is modified, it dispatches the titleBarFactoryChanged event.



Implementation
    public function get titleBarFactory():IFactory
    public function set titleBarFactory(value:IFactory):void
AIR-only 

titleBarStyleFilters

property 
titleBarStyleFilters:Object  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Set of styles to pass from the Window to the titleBar.



Implementation
    protected function get titleBarStyleFilters():Object

See also

AIR-only 

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.

The default value is null.

This property can be used as the source for data binding. When this property is modified, it dispatches the titleIconChanged event.



Implementation
    public function get titleIcon():Class
    public function set titleIcon(value:Class):void
AIR-only 

transparent

property 
transparent:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Specifies whether the window is transparent. Setting this property to true for a window that uses system chrome is not supported.

This property is read-only after the window has been opened.



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

type

property 
type:String

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.

This property is read-only once the window has been opened.

The default value is NativeWindowType.NORMAL.



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

See also

Constructor Detail
AIR-only 

Window

()Constructor
public function Window()

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Constructor.

Method Detail

AIR-only activate

()method
public function activate():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Activates the underlying NativeWindow (even if this Window's application is not currently active).

AIR-only close

()method 
public function close():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Closes the window. This action is cancelable.

AIR-only getWindow

()method 
public static function getWindow(component:UIComponent):IWindow

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Returns the Window to which a component is parented.

Parameters

component:UIComponent — the component whose Window you wish to find.

Returns
IWindow

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

AIR-only minimize

()method 
public function minimize():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Minimizes the window.

AIR-only mouseDownHandler

()method 
protected function mouseDownHandler(event:MouseEvent):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Manages mouse down events on the window border.

Parameters

event:MouseEvent

AIR-only open

()method 
public function open(openWindowActive:Boolean = true):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Creates the underlying NativeWindow and opens it. After being closed, the Window object is still a valid reference, but accessing most properties and methods will not work. Closed windows cannot be reopened.

Parameters

openWindowActive:Boolean (default = true) — specifies whether the Window opens activated (that is, whether it has focus). The default value is true.

AIR-only orderInBackOf

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Orders the window just behind another. To order the window behind a NativeWindow that does not implement IWindow, use this window's nativeWindow's orderInBackOf() method.

Parameters

window:IWindow — The IWindow (Window or WindowedAplication) to order this window behind.

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

AIR-only orderInFrontOf

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Orders the window just in front of another. To order the window in front of a NativeWindow that does not implement IWindow, use this window's nativeWindow's orderInFrontOf() method.

Parameters

window:IWindow — The IWindow (Window or WindowedAplication) to order this window in front of.

Returns
Booleantrue if the window was succesfully sent in front; false if the window is invisible or minimized.

AIR-only orderToBack

()method 
public function orderToBack():Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Orders the window behind all others in the same application.

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

AIR-only orderToFront

()method 
public function orderToFront():Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Orders the window in front of all others in the same application.

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

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

Event Detail
AIR-only 

applicationActivate

Event
Event Object Type: mx.events.AIREvent
property AIREvent.type = mx.events.AIREvent.APPLICATION_ACTIVATE

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Dispatched when this application gets activated.

The AIREvent.APPLICATION_ACTIVATE constant defines the value of the type property of the event object for an applicationActivate event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
fileThe File object associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeAIREvent.APPLICATION_ACTIVATE
AIR-only 

applicationDeactivate

Event  
Event Object Type: mx.events.AIREvent
property AIREvent.type = mx.events.AIREvent.APPLICATION_DEACTIVATE

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Dispatched when this application gets deactivated.

The AIREvent.APPLICATION_DEACTIVATE constant defines the value of the type property of the event object for an applicationDeactivate event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
fileThe File object associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeAIREvent.APPLICATION_DEACTIVATE
AIR-only 

close

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

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

See also

AIR-only 

closing

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Dispatched before the window closes. This event is cancelable.

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.

See also

AIR-only 

displayStateChange

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Dispatched after the display state changes to minimize, maximize or restore.

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Dispatched before the display state changes to minimize, maximize or restore.

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

moving

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Dispatched before the window moves, and while the window is being dragged.

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

This event has the following properties:

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

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

AIR-only 

networkChange

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Dispatched when the computer connects to or disconnects from the network.

The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange 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 NativeApplication object.
AIR-only 

resizing

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Dispatched before the underlying NativeWindow is resized, or while the Window object boundaries are being dragged.

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

This event has the following properties:

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

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

AIR-only 

windowActivate

Event  
Event Object Type: mx.events.AIREvent
property AIREvent.type = mx.events.AIREvent.WINDOW_ACTIVATE

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Dispatched after the window has been activated.

The AIREvent.WINDOW_ACTIVATE constant defines the value of the type property of the event object for a windowActivate event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
fileThe File object associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeAIREvent.WINDOW_ACTIVATE
AIR-only 

windowComplete

Event  
Event Object Type: mx.events.AIREvent
property AIREvent.type = mx.events.AIREvent.WINDOW_COMPLETE

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Dispatched when the Window completes its initial layout and opens the underlying NativeWindow.

The AIREvent.WINDOW_COMPLETE constant defines the value of the type property of the event object for an windowComplete event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
fileThe File object associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeAIREvent.WINDOW_COMPLETE
AIR-only 

windowDeactivate

Event  
Event Object Type: mx.events.AIREvent
property AIREvent.type = mx.events.AIREvent.WINDOW_DEACTIVATE

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Dispatched after the window has been deactivated.

The AIREvent.WINDOW_DEACTIVATE constant defines the value of the type property of the event object for a windowDeactivate event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
fileThe File object associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeAIREvent.WINDOW_DEACTIVATE
AIR-only 

windowMove

Event  
Event Object Type: mx.events.FlexNativeWindowBoundsEvent
property FlexNativeWindowBoundsEvent.type = mx.events.FlexNativeWindowBoundsEvent.WINDOW_MOVE

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Dispatched after the window moves.

The FlexNativeWindowBoundsEvent.WINDOW_MOVE constant defines the value of the type property of the event object for a windowMove event.

The properties of the event object have the following values:

PropertyValue
afterBoundsThe bounds of the window after the bounds changed.
beforeBoundsThe bounds of the window before the bounds changed.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
fileThe File object associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeFlexNativeWindowBoundsEvent.WINDOW_MOVE
AIR-only 

windowResize

Event  
Event Object Type: mx.events.FlexNativeWindowBoundsEvent
property FlexNativeWindowBoundsEvent.type = mx.events.FlexNativeWindowBoundsEvent.WINDOW_RESIZE

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: AIR 1.1

Dispatched after the underlying NativeWindow is resized.

The FlexNativeWindowBoundsEvent.WINDOW_RESIZE constant defines the value of the type property of the event object for a windowResize event.

The properties of the event object have the following values:

PropertyValue
afterBoundsThe bounds of the window after the bounds changed.
beforeBoundsThe bounds of the window before the bounds changed.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
fileThe File object associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeFlexNativeWindowBoundsEvent.WINDOW_RESIZE