Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
WindowedApplication

Package | mx.core
Class | public class WindowedApplication
Inheritance | WindowedApplication Application LayoutContainer Container UIComponent FlexSprite flash.display.Sprite
Implements | IWindow

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

| Starting with Flex 4.0, Apache recommends that you use the spark.components.WindowedApplication class as an alternative to this class.

The WindowedApplication defines the application container that you use to create Flex applications for AIR applications.

The WindowedApplication serves two roles. It is a replacement for the <mx:Application> tag, functioning as the entry point to a Flex-based AIR application. In addition, as a container the WindowedApplication defines the layout of the initial window of a Flex AIR application -- any visual controls defined in the WindowedApplication become the content of the initial window loaded by the AIR application.

A WindowedApplication is the top-level application of a Flex-based AIR application. It is not designed to be loaded by other Flex applications. If a WindowedApplication needs to load other applications, use the Application class as container for those applications. If other windows are required, use the Window class as a container for those windows.

Note that because the WindowedApplication only represents the visual content of a single window, and not all the windows in a multi-window application, a WindowedApplication instance only dispatches display-related events (events that the WindowedApplication class inherits from display object base classes such as InteractiveObject or UIComponent) for its own stage and window, and not for events that occur on other windows in the application. This differs from a browser-based application, where an Application container dispatches events for all the windows in the application (because technically those windows are all display objects rendered on the single Application stage).

MXML Syntax Show MXML Syntax
Hide MXML Syntax

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

      <mx:WindowedApplication
        Properties
        alwaysInFront="false"
        autoExit="true"
        backgroundFrameRate="-1"
        dockIconMenu="null"
        maxHeight="2880 less the height of the system chrome"
        maxWidth="2880 less the width of the system chrome"
        menu="null"
        minHeight="dependent on the operating system and the AIR systemChrome setting"
        minWidth="dependent on the operating system and the AIR systemChrome setting"
        showGripper="true"
        showStatusBar="true"
        showTitleBar="true"
        status=""
        statusBarFactory="mx.core.ClassFactory"
        systemTrayIconMenu="null"
        title=""
        titleBarFactory="mx.core.ClassFactory"
        titleIcon="null"
        useNativeDragManager="true"

        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"
        invoke="No default"
        moving="No default"
        networkChange="No default"
        resizing="No default"
        windowComplete="No default"
        windowMove="No default"
        windowResize="No default"
      />

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityDescription : String A convenience accessor for the description property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityEnabled : Boolean A convenience accessor for the silent property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityName : String A convenience accessor for the name property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityShortcut : String A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object. | UIComponent
|  | activeEffects : Array [read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances. | UIComponent
|  | alwaysInFront : Boolean Determines whether the underlying NativeWindow is always in front of other windows. | WindowedApplication
|  | application : Object Deprecated Since 4.0: Please Use FlexGlobals.topLevelApplication [static] [read-only] A reference to the top-level application. | Application
|  | applicationID : String [read-only] The identifier that AIR uses to identify the application. | WindowedApplication
|  | autoExit : Boolean Specifies whether the AIR application will quit when the last window closes or will continue running in the background. | WindowedApplication
|  | autoLayout : Boolean If true, measurement and layout are done when the position or size of a child is changed. | Container
|  | automationDelegate : Object The delegate object that handles the automation-related functionality. | UIComponent
|  | automationEnabled : Boolean [read-only] True if this component is enabled for automation, false otherwise. | UIComponent
|  | automationName : String Name that can be used as an identifier for this object. | UIComponent
|  | automationOwner : DisplayObjectContainer [read-only] The owner of this component for automation purposes. | UIComponent
|  | automationParent : DisplayObjectContainer [read-only] The parent of this component for automation purposes. | UIComponent
|  | automationTabularData : Object [read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data. | UIComponent
|  | automationValue : 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
|  | automationVisible : Boolean [read-only] True if this component is visible for automation, false otherwise. | UIComponent
|  | backgroundFrameRate : Number Specifies the frame rate to use when the application is inactive. | WindowedApplication
|  | baseline : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text of the component. | UIComponent
|  | borderMetrics : EdgeMetrics [read-only] Returns an EdgeMetrics object that has four properties: left, top, right, and bottom. | Container
|  | bottom : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | cacheHeuristic : Boolean [write-only] Used by Flex to suggest bitmap caching for the object. | UIComponent
|  | cachePolicy : String Specifies the bitmap caching policy for this object. | UIComponent
|  | childDescriptors : Array [read-only] Array of UIComponentDescriptor objects produced by the MXML compiler. | Container
|  | className : String [read-only] The name of this instance's class, such as "Button". | UIComponent
|  | clipContent : 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
|  | closed : Boolean [read-only] Returns true when the underlying window has been closed. | WindowedApplication
|  | constraintColumns : Array An Array of ConstraintColumn instances that partition this container. | LayoutContainer
|  | constraintRows : Array An Array of ConstraintRow instances that partition this container. | LayoutContainer
|  | contentMouseX : Number [override] [read-only] Returns the x position of the mouse, in the content coordinate system. | Container
|  | contentMouseY : Number [override] [read-only] Returns the y position of the mouse, in the content coordinate system. | Container
|  | controlBar : IUIComponent The ApplicationControlBar for this Application. | Application
|  | creatingContentPane : Boolean Containers use an internal content pane to control scrolling. | Container
|  | creationIndex : int Deprecated: Deprecated Specifies the order to instantiate and draw the children of the container. | Container
|  | creationPolicy : String The child creation policy for this MX Container. | Container
|  | currentState : String The current view state of the component. | UIComponent
|  | cursorManager : ICursorManager [read-only] Gets the CursorManager that controls the cursor for this component and its peers. | UIComponent
|  | data : Object The data property lets you pass a value to the component when you use it in an item renderer or item editor. | Container
|  | defaultButton : IFlexDisplayObject The Button control designated as the default button for the container. | Container
|  | deferredContentCreated : Boolean [read-only] IDeferredContentOwner equivalent of processedDescriptors | Container
|  | depth : Number Determines the order in which items inside of containers are rendered. | UIComponent
|  | descriptor : UIComponentDescriptor Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance. | UIComponent
|  | designLayer : DesignLayer Specifies the optional DesignLayer instance associated with this visual element. | UIComponent
|  | dockIconMenu : FlexNativeMenu The dock icon menu. | WindowedApplication
|  | document : Object A reference to the document object associated with this UIComponent. | UIComponent
|  | doubleClickEnabled : Boolean [override] Specifies whether the UIComponent object receives doubleClick events. | UIComponent
|  | enabled : Boolean Whether the component can accept user interaction. | UIComponent
|  | errorString : String The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails. | UIComponent
|  | explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates. | UIComponent
|  | explicitMaxHeight : Number The maximum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | explicitMaxWidth : Number The maximum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | explicitMinHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | explicitMinWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates. | UIComponent
|  | flexContextMenu : IFlexContextMenu The context menu for this UIComponent. | UIComponent
|  | focusEnabled : Boolean Indicates whether the component can receive focus when tabbed to. | UIComponent
|  | focusManager : IFocusManager Gets the FocusManager that controls focus for this component and its peers. | UIComponent
|  | focusPane : Sprite The focus pane associated with this object. | UIComponent
|  | frameRate : Number Specifies the frame rate of the application. | Application
|  | hasFocusableChildren : Boolean A flag that indicates whether child objects can receive focus. | UIComponent
|  | hasLayoutMatrix3D : Boolean [read-only] Contains true if the element has 3D Matrix. | UIComponent
|  | height : Number [override] Number that specifies the height of the component, in pixels, in the parent's coordinates. | UIComponent
|  | historyManagementEnabled : Boolean = true If false, the history manager will be disabled. | Application
|  | horizontalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | horizontalLineScrollSize : Number Number of pixels to move when the left- or right-arrow button in the horizontal scroll bar is pressed. | Container
|  | horizontalPageScrollSize : Number Number of pixels to move when the track in the horizontal scroll bar is pressed. | Container
|  | horizontalScrollBar : ScrollBar The horizontal scrollbar used in this container. | Container
|  | horizontalScrollPolicy : String Specifies whether the horizontal scroll bar is always present, always absent, or automatically added when needed. | Container
|  | horizontalScrollPosition : Number The current position of the horizontal scroll bar. | Container
|  | id : String ID of the component. | UIComponent
|  | includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container. | UIComponent
|  | inheritingStyles : Object The beginning of this component's chain of inheriting styles. | UIComponent
|  | initialized : 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
|  | instanceIndex : int [read-only] The index of a repeated component. | UIComponent
|  | instanceIndices : Array An Array containing the indices required to reference this UIComponent object from its parent document. | UIComponent
|  | is3D : Boolean [read-only] Contains true when the element is in 3D. | UIComponent
|  | isDocument : Boolean [read-only] Contains true if this UIComponent instance is a document object. | UIComponent
|  | isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up. | UIComponent
|  | layout : String Specifies the layout mechanism used for this application. | LayoutContainer
|  | layoutMatrix3D : Matrix3D [write-only] The transform matrix that is used to calculate a component's layout relative to its siblings. | UIComponent
|  | left : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | maintainProjectionCenter : Boolean When true, the component keeps its projection matrix centered on the middle of its bounding box. | UIComponent
|  | maxHeight : Number The maximum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | maxHorizontalScrollPosition : Number [read-only] The largest possible value for the horizontalScrollPosition property. | Container
|  | maximizable : Boolean [read-only] Specifies whether the window can be maximized. | WindowedApplication
|  | maxVerticalScrollPosition : Number [read-only] The largest possible value for the verticalScrollPosition property. | Container
|  | maxWidth : Number The maximum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | measuredHeight : Number The default height of the component, in pixels. | UIComponent
|  | measuredMinHeight : Number The default minimum height of the component, in pixels. | UIComponent
|  | measuredMinWidth : Number The default minimum width of the component, in pixels. | UIComponent
|  | measuredWidth : Number The default width of the component, in pixels. | UIComponent
|  | menu : FlexNativeMenu The application menu for operating systems that support an application menu, or the window menu of the application's initial window for operating systems that support window menus. | WindowedApplication
|  | minHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | minimizable : Boolean [read-only] Specifies whether the window can be minimized. | WindowedApplication
|  | minWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | moduleFactory : 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
|  | mouseFocusEnabled : Boolean Whether you can receive focus when clicked on. | UIComponent
|  | MXMLDescriptor : Array [read-only] | UIComponent
|  | MXMLProperties : Array [read-only] | UIComponent
|  | nativeApplication : NativeApplication [read-only] The NativeApplication object representing the AIR application. | WindowedApplication
|  | nativeWindow : NativeWindow [read-only] The NativeWindow used by this WindowedApplication component (the initial native window of the application). | WindowedApplication
|  | nestLevel : int Depth of this object in the containment hierarchy. | UIComponent
|  | nonInheritingStyles : Object The beginning of this component's chain of non-inheriting styles. | UIComponent
|  | numAutomationChildren : int [read-only] The number of automation children this container has. | UIComponent
|  | numChildren : int [override] [read-only] Number of child components in this container. | Container
|  | numElements : int [read-only] The number of visual elements in this container. | Container
|  | owner : DisplayObjectContainer The owner of this IVisualElement object. | UIComponent
|  | pageTitle : String Specifies a string that appears in the title bar of the browser. | Application
|  | parameters : Object [read-only] The parameters property returns an Object containing name-value pairs representing the parameters provided to this Application. | Application
|  | parent : DisplayObjectContainer [override] [read-only] The parent container or component for this component. | UIComponent
|  | parentApplication : Object [read-only] A reference to the Application object that contains this UIComponent instance. | UIComponent
|  | parentDocument : Object [read-only] A reference to the parent document object for this UIComponent. | UIComponent
|  | percentHeight : Number Specifies the height of a component as a percentage of its parent's size. | UIComponent
|  | percentWidth : Number Specifies the width of a component as a percentage of its parent's size. | UIComponent
|  | postLayoutTransformOffsets : 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
|  | preloader : Object The application container supports an application preloader that uses a download progress bar to show the download and initialization progress of an application SWF file. | Application
|  | preloaderChromeColor : uint Specifies the base color used by the default preloader component. | Application
|  | processedDescriptors : Boolean Set to true after immediate or deferred child creation, depending on which one happens. | UIComponent
|  | rawChildren : IChildList [read-only] A container typically contains child components, which can be enumerated using the Container.getChildAt() method and Container.numChildren property. | Container
|  | repeater : IRepeater [read-only] A reference to the Repeater object in the parent document that produced this UIComponent. | UIComponent
|  | repeaterIndex : int [read-only] The index of the item in the data provider of the Repeater that produced this UIComponent. | UIComponent
|  | repeaterIndices : 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
|  | repeaters : Array An Array containing references to the Repeater objects in the parent document that produced this UIComponent. | UIComponent
|  | resetHistory : Boolean = true If true, the application's history state is reset to its initial state whenever the application is reloaded. | Application
|  | resizable : Boolean [read-only] Specifies whether the window can be resized. | WindowedApplication
|  | right : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | rotation : Number [override] | UIComponent
|  | rotationX : Number [override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent
|  | rotationY : Number [override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent
|  | rotationZ : Number [override] | UIComponent
|  | scaleX : Number [override] Number that specifies the horizontal scaling factor. | UIComponent
|  | scaleY : Number [override] Number that specifies the vertical scaling factor. | UIComponent
|  | scaleZ : Number [override] Number that specifies the scaling factor along the z axis. | UIComponent
|  | screen : Rectangle [read-only] Returns an object that contains the size and position of the base drawing surface for this object. | UIComponent
|  | scriptRecursionLimit : int Specifies the maximum depth of Flash Player or AIR call stack before the player stops. | Application
|  | showGripper : Boolean If true, the gripper is visible. | WindowedApplication
|  | showInAutomationHierarchy : Boolean A flag that determines if an automation object shows in the automation hierarchy. | UIComponent
|  | showStatusBar : Boolean If true, the status bar is visible. | WindowedApplication
|  | showTitleBar : Boolean If true, the window's title bar is visible. | WindowedApplication
|  | states : Array The view states that are defined for this component. | UIComponent
|  | status : String The string that appears in the status bar, if it is visible. | WindowedApplication
|  | statusBar : UIComponent [read-only] The UIComponent that displays the status bar. | WindowedApplication
|  | statusBarFactory : IFactory The IFactory that creates an instance to use as the status bar. | WindowedApplication
|  | styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object. | UIComponent
|  | styleManager : IStyleManager2 [read-only] Returns the StyleManager instance used by this component. | UIComponent
|  | styleName : Object The class style used by this component. | UIComponent
|  | styleParent : IAdvancedStyleClient A component's parent is used to evaluate descendant selectors. | UIComponent
|  | systemChrome : String [read-only] Specifies the type of system chrome (if any) the window has. | WindowedApplication
|  | systemManager : ISystemManager Returns the SystemManager object used by this component. | UIComponent
|  | systemTrayIconMenu : FlexNativeMenu The system tray icon menu. | WindowedApplication
|  | tabFocusEnabled : 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
|  | title : String The title that appears in the window title bar and the taskbar. | WindowedApplication
|  | titleBar : UIComponent [read-only] The UIComponent that displays the title bar. | WindowedApplication
|  | titleBarFactory : IFactory The IFactory that creates an instance to use as the title bar. | WindowedApplication
|  | titleIcon : Class The Class (usually an image) used to draw the title bar icon. | WindowedApplication
|  | top : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | transform : Transform [override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | UIComponent
|  | transformX : Number Sets the x coordinate for the transform center of the component. | UIComponent
|  | transformY : Number Sets the y coordinate for the transform center of the component. | UIComponent
|  | transformZ : Number Sets the z coordinate for the transform center of the component. | UIComponent
|  | transitions : Array An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs. | UIComponent
|  | transparent : Boolean [read-only] Specifies whether the window is transparent. | WindowedApplication
|  | tweeningProperties : Array Array of properties that are currently being tweened on this object. | UIComponent
|  | type : String [read-only] Specifies the type of NativeWindow that this component represents. | WindowedApplication
|  | uid : String A unique identifier for the object. | UIComponent
|  | updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required). | UIComponent
|  | url : String [read-only] The URL from which this Application's SWF file was loaded. | Application
|  | useNativeDragManager : Boolean = true If true, the DragManager should use the NativeDragManagerImpl implementation class. | WindowedApplication
|  | usePreloader : Boolean If true, specifies to display the application preloader. | Application
|  | validationSubField : String Used by a validator to associate a subfield with this component. | UIComponent
|  | verticalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | verticalLineScrollSize : 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
|  | verticalPageScrollSize : Number Number of pixels to scroll when the track in the vertical scroll bar is pressed. | Container
|  | verticalScrollBar : ScrollBar The vertical scrollbar used in this container. | Container
|  | verticalScrollPolicy : String Specifies whether the vertical scroll bar is always present, always absent, or automatically added when needed. | Container
|  | verticalScrollPosition : Number The current position of the vertical scroll bar. | Container
|  | viewMetrics : EdgeMetrics [read-only] Returns an object that has four properties: left, top, right, and bottom. | Container
|  | viewMetricsAndPadding : EdgeMetrics [read-only] Returns an object that has four properties: left, top, right, and bottom. | Container
|  | viewSourceURL : String URL where the application's source can be viewed. | Application
|  | visible : Boolean [override] Whether or not the display object is visible. | UIComponent
|  | width : Number [override] Number that specifies the width of the component, in pixels, in the parent's coordinates. | UIComponent
|  | z : Number [override] | UIComponent

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | actualCreationPolicy : String The creation policy of this container. | Container
|  | boxLayoutClass : Class The mx.containers.utilityClasses.Layout subclass that is doing the layout | LayoutContainer
|  | canvasLayoutClass : Class The mx.containers.utilityClasses.Layout subclass that is doing the layout | LayoutContainer
|  | currentCSSState : String [read-only] The state to be used when matching CSS pseudo-selectors. | UIComponent
|  | hasComplexLayoutMatrix : Boolean [read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent
|  | resourceManager : IResourceManager [read-only] A reference to the object which manages all of the application's localized resources. | UIComponent
|  | statusBarStyleFilters : Object [read-only] Set of styles to pass from the WindowedApplication to the status bar. | WindowedApplication
|  | titleBarStyleFilters : Object [read-only] Set of styles to pass from the WindowedApplication to the titleBar. | WindowedApplication
|  | unscaledHeight : Number [read-only] A convenience method for determining the unscaled height of the component. | UIComponent
|  | unscaledWidth : 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
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | WindowedApplication() Constructor. | WindowedApplication
|  | activate():void Activates the underlying NativeWindow (even if this application is not the active one). | WindowedApplication
|  | addChild(child:DisplayObject):DisplayObject [override] Adds a child DisplayObject to this Container. | Container
|  | addChildAt(child:DisplayObject, index:int):DisplayObject [override] Adds a child DisplayObject to this Container. | Container
|  | addElement(element:IVisualElement):IVisualElement Adds a visual element to this container. | Container
|  | addElementAt(element:IVisualElement, index:int):IVisualElement Adds a visual element to this container. | Container
|  | addStyleClient(styleClient:IAdvancedStyleClient):void Adds a non-visual style client to this component instance. | UIComponent
|  | addToCreationQueue(id:Object, preferredIndex:int = -1, callbackFunc:Function = null, parent:IFlexDisplayObject = null):void Add a container to the Application's creation queue. | Application
|  | callLater(method:Function, args:Array = null):void Queues a function to be called later. | UIComponent
|  | clearStyle(styleProp:String):void Deletes a style property from this component instance. | UIComponent
|  | close():void Closes the application's NativeWindow (the initial native window opened by the application). | WindowedApplication
|  | contentToGlobal(point:Point):Point [override] Converts a Point object from content coordinates to global coordinates. | Container
|  | contentToLocal(point:Point):Point [override] Converts a Point object from content to local coordinates. | Container
|  | createAutomationIDPart(child:IAutomationObject):Object Returns a set of properties that identify the child within this container. | UIComponent
|  | createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object Returns a set of properties as automation IDs that identify the child within this container. | UIComponent
|  | createComponentFromDescriptor(descriptor:ComponentDescriptor, recurse:Boolean):IFlexDisplayObject Given a single UIComponentDescriptor, create the corresponding component and add the component as a child of this Container. | Container
|  | createComponentsFromDescriptors(recurse:Boolean = true):void Iterate through the Array of childDescriptors, and call the createComponentFromDescriptor() method for each one. | Container
|  | createDeferredContent():void Performs the equivalent action of calling the createComponentsFromDescriptors(true) method for containers that implement the IDeferredContentOwner interface to support deferred instantiation. | Container
|  | createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Creates an id reference to this IUIComponent object on its parent document object. | UIComponent
|  | deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Deletes the id reference to this IUIComponent object on its parent document object. | UIComponent
|  | determineTextFormatFromStyles():UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent. | UIComponent
|  | dispatchEvent(event:Event):Boolean [override] Dispatches an event into the event flow. | UIComponent
|  | drawFocus(isFocused:Boolean):void Shows or hides the focus indicator around this component. | UIComponent
|  | 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
|  | effectFinished(effectInst:IEffectInstance):void Called by the effect instance when it stops playing on the component. | UIComponent
|  | effectStarted(effectInst:IEffectInstance):void Called by the effect instance when it starts playing on the component. | UIComponent
|  | endEffectsStarted():void Ends all currently playing effects on the component. | UIComponent
|  | executeBindings(recurse:Boolean = false):void [override] Executes all the data bindings on this Container. | Container
|  | executeChildBindings(recurse:Boolean):void Executes the bindings into this Container's child UIComponent objects. | Container
|  | exit():void Closes the window and exits the application. | WindowedApplication
|  | finishPrint(obj:Object, target:IFlexDisplayObject):void Called after printing is complete. | UIComponent
|  | generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent
|  | generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent
|  | getAutomationChildAt(index:int):IAutomationObject Provides the automation object at the specified index. | UIComponent
|  | getAutomationChildren():Array Provides the automation object list . | UIComponent
|  | getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size. | UIComponent
|  | getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size. | UIComponent
|  | getChildAt(index:int):DisplayObject [override] Gets the nth child component object. | Container
|  | getChildByName(name:String):DisplayObject [override] Returns the child whose name property is the specified String. | Container
|  | getChildIndex(child:DisplayObject):int [override] Gets the zero-based index of a specific child. | Container
|  | getChildren():Array Returns an Array of DisplayObject objects consisting of the content children of the container. | Container
|  | getClassStyleDeclarations():Array Finds the type selectors for this UIComponent instance. | UIComponent
|  | getConstraintValue(constraintName:String):* Returns a layout constraint value, which is the same as getting the constraint style for this component. | UIComponent
|  | getElementAt(index:int):IVisualElement Returns the visual element at the specified index. | Container
|  | getElementIndex(element:IVisualElement):int Returns the index position of a visual element. | Container
|  | getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height | UIComponent
|  | getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width | UIComponent
|  | getFocus():InteractiveObject Gets the object that currently has focus. | UIComponent
|  | getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height. | UIComponent
|  | getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width. | UIComponent
|  | getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen. | UIComponent
|  | getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen. | UIComponent
|  | getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings. | UIComponent
|  | getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element. | UIComponent
|  | getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height. | UIComponent
|  | getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width. | UIComponent
|  | getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height. | UIComponent
|  | getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width. | UIComponent
|  | getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height. | UIComponent
|  | getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width. | UIComponent
|  | 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
|  | getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain. | UIComponent
|  | getVisibleRect(targetParent:DisplayObject = null):Rectangle Get the bounds of this object that are visible to the user on the screen. | UIComponent
|  | globalToContent(point:Point):Point [override] Converts a Point object from global to content coordinates. | Container
|  | hasCSSState():Boolean Returns true if currentCSSState is not null. | UIComponent
|  | hasState(stateName:String):Boolean Determines whether the specified state has been defined on this UIComponent. | UIComponent
|  | horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient. | UIComponent
|  | initialize():void Initializes the internal structure of this component. | UIComponent
|  | initializeRepeaterArrays(parent:IRepeaterClient):void Initializes various properties which keep track of repeated instances of this component. | UIComponent
|  | invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update. | UIComponent
|  | invalidateLayering():void Called by a component's items to indicate that their depth property has changed. | UIComponent
|  | invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes. | UIComponent
|  | invalidateProperties():void Marks a component so that its commitProperties() method gets called during a later screen update. | UIComponent
|  | invalidateSize():void Marks a component so that its measure() method gets called during a later screen update. | UIComponent
|  | localToContent(point:Point):Point [override] Converts a Point object from local to content coordinates. | Container
|  | matchesCSSState(cssState:String):Boolean Returns true if cssState matches currentCSSState. | UIComponent
|  | matchesCSSType(cssType:String):Boolean Determines whether this instance is the same as, or is a subclass of, the given type. | UIComponent
|  | maximize():void Maximizes the window, or does nothing if it's already maximized. | WindowedApplication
|  | measureHTMLText(htmlText:String):TextLineMetrics 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
|  | measureText(text:String):TextLineMetrics 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
|  | minimize():void Minimizes the window. | WindowedApplication
|  | move(x:Number, y:Number):void Moves the component to a specified position within its parent. | UIComponent
|  | notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children. | UIComponent
|  | orderInBackOf(window:IWindow):Boolean Orders the window just behind another. | WindowedApplication
|  | orderInFrontOf(window:IWindow):Boolean Orders the window just in front of another. | WindowedApplication
|  | orderToBack():Boolean Orders the window behind all others in the same application. | WindowedApplication
|  | orderToFront():Boolean Orders the window in front of all others in the same application. | WindowedApplication
|  | owns(child:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent. | UIComponent
|  | parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent
|  | prepareToPrint(target:IFlexDisplayObject):Object Prepares an IFlexDisplayObject for printing. | UIComponent
|  | regenerateStyleCache(recursive:Boolean):void 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
|  | registerEffects(effects:Array):void For each effect event, registers the EffectManager as one of the event listeners. | UIComponent
|  | removeAllChildren():void Removes all children from the child list of this container. | Container
|  | removeAllElements():void Removes all visual elements from the container. | Container
|  | removeChild(child:DisplayObject):DisplayObject [override] Removes a child DisplayObject from the child list of this Container. | Container
|  | removeChildAt(index:int):DisplayObject [override] Removes a child DisplayObject from the child list of this Container at the specified index. | Container
|  | removeElement(element:IVisualElement):IVisualElement Removes the specified visual element from the child list of this container. | Container
|  | removeElementAt(index:int):IVisualElement Removes a visual element from the specified index position in the container. | Container
|  | removeStyleClient(styleClient:IAdvancedStyleClient):void Removes a non-visual style client from this component instance. | UIComponent
|  | replayAutomatableEvent(event:Event):Boolean Replays the specified event. | UIComponent
|  | resolveAutomationIDPart(criteria:Object):Array Resolves a child by using the id provided. | UIComponent
|  | restore():void Restores the window (unmaximizes it if it's maximized, or unminimizes it if it's minimized). | WindowedApplication
|  | resumeBackgroundProcessing():void [static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing(). | UIComponent
|  | setActualSize(w:Number, h:Number):void Sizes the object. | UIComponent
|  | setChildIndex(child:DisplayObject, newIndex:int):void [override] Sets the index of a particular child. | Container
|  | setConstraintValue(constraintName:String, value:*):void Sets a layout constraint value, which is the same as setting the constraint style for this component. | UIComponent
|  | setCurrentState(stateName:String, playTransition:Boolean = true):void Set the current state. | UIComponent
|  | setElementIndex(element:IVisualElement, index:int):void Changes the position of an existing visual element in the visual container. | Container
|  | setFocus():void Sets the focus to this component. | UIComponent
|  | setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen. | UIComponent
|  | setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element. | UIComponent
|  | 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
|  | 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
|  | setMXMLDescriptor(value:Array):void | UIComponent
|  | setMXMLProperties(value:Array):void | UIComponent
|  | setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance. | UIComponent
|  | setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes. | UIComponent
|  | styleChanged(styleProp:String):void Detects changes to style properties. | UIComponent
|  | stylesInitialized():void Flex calls the stylesInitialized() method when the styles for a component are first initialized. | UIComponent
|  | suspendBackgroundProcessing():void [static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called. | UIComponent
|  | swapElements(element1:IVisualElement, element2:IVisualElement):void Swaps the index of the two specified visual elements. | Container
|  | swapElementsAt(index1:int, index2:int):void Swaps the visual elements at the two specified index positions in the container. | Container
|  | toString():String [override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application. | FlexSprite
|  | 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
|  | 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
|  | validateDisplayList():void Validates the position and size of children and draws other visuals. | UIComponent
|  | validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary. | UIComponent
|  | validateProperties():void Used by layout logic to validate the properties of a component by calling the commitProperties() method. | UIComponent
|  | 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
|  | validationResultHandler(event:ValidationResultEvent):void Handles both the valid and invalid events from a validator assigned to this component. | UIComponent
|  | verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient. | UIComponent

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | addMXMLChildren(comps:Array):void | UIComponent
|  | adjustFocusRect(obj:DisplayObject = null):void Adjust the focus rectangle. | UIComponent
|  | applyComputedMatrix():void Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform. | UIComponent
|  | attachOverlay():void [override] Used internally by the Dissolve Effect to add the overlay to the chrome of a container. | Container
|  | canSkipMeasurement():Boolean Determines if the call to the measure() method can be skipped. | UIComponent
|  | childrenCreated():void Performs any final processing after child objects are created. | UIComponent
|  | commitProperties():void Processes the properties set on the component. | UIComponent
|  | createBorder():void Creates the container's border skin if it is needed and does not already exist. | Container
|  | createChildren():void Create child objects of the component. | UIComponent
|  | createInFontContext(classObj:Class):Object Creates a new object using a context based on the embedded font being used. | UIComponent
|  | createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object Creates the object using a given moduleFactory. | UIComponent
|  | dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void Helper method for dispatching a PropertyChangeEvent when a property is updated. | UIComponent
|  | focusInHandler(event:FocusEvent):void The event handler called when a UIComponent object gets focus. | UIComponent
|  | focusOutHandler(event:FocusEvent):void The event handler called when a UIComponent object loses focus. | UIComponent
|  | generateMXMLAttributes(data:Array):void | UIComponent
|  | generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void | UIComponent
|  | generateMXMLObject(document:Object, data:Array):Object | UIComponent
|  | initAdvancedLayoutFeatures():void Initializes the implementation and storage of some of the less frequently used advanced layout features of a component. | UIComponent
|  | initializationComplete():void Finalizes the initialization of this component. | UIComponent
|  | initializeAccessibility():void Initializes this component's accessibility code. | UIComponent
|  | invalidateParentSizeAndDisplayList():void Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true). | UIComponent
|  | isOurFocus(target:DisplayObject):Boolean Typically overridden by components containing UITextField objects, where the UITextField object gets focus. | UIComponent
|  | keyDownHandler(event:KeyboardEvent):void The event handler called for a keyDown event. | UIComponent
|  | keyUpHandler(event:KeyboardEvent):void The event handler called for a keyUp event. | UIComponent
|  | layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void Respond to size changes by setting the positions and sizes of this container's borders. | Container
|  | measure():void Calculates the default size, and optionally the default minimum size, of the component. | UIComponent
|  | resourcesChanged():void 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
|  | scrollChildren():void Positions the container's content area relative to the viewable area based on the horizontalScrollPosition and verticalScrollPosition properties. | Container
|  | setStretchXY(stretchX:Number, stretchY:Number):void Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent
|  | 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
|  | updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override] Respond to size changes by setting the positions and sizes of this container's children. | Container

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | add | Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent
|  | applicationActivate | Dispatched when this application is activated. | WindowedApplication
|  | applicationComplete | Dispatched after the Application has been initialized, processed by the LayoutManager, and attached to the display list. | Application
|  | applicationDeactivate | Dispatched when this application is deactivated. | WindowedApplication
|  | childAdd | Dispatched after a child has been added to a container. | Container
|  | childIndexChange | Dispatched after the index (among the container children) of a container child changes. | Container
|  | childRemove | Dispatched before a child of a container is removed. | Container
|  | close | Dispatched after this application window has been closed. | WindowedApplication
|  | closing | Dispatched before the WindowedApplication window closes. | WindowedApplication
|  | creationComplete | Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent
|  | currentStateChange | Dispatched after the view state has changed. | UIComponent
|  | currentStateChanging | Dispatched after the currentState property changes, but before the view state changes. | UIComponent
|  | dataChange | Dispatched when the data property changes. | Container
|  | displayStateChange | Dispatched after the display state changes to minimize, maximize or restore. | WindowedApplication
|  | displayStateChanging | Dispatched before the display state changes to minimize, maximize or restore. | WindowedApplication
|  | dragComplete | Dispatched 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
|  | dragDrop | Dispatched by the drop target when the user releases the mouse over it. | UIComponent
|  | dragEnter | Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent
|  | dragExit | Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent
|  | dragOver | Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent
|  | dragStart | Dispatched by the drag initiator when starting a drag operation. | UIComponent
|  | effectEnd | Dispatched after an effect ends. | UIComponent
|  | effectStart | Dispatched just before an effect starts. | UIComponent
|  | effectStop | Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent
|  | enterState | Dispatched after the component has entered a view state. | UIComponent
|  | error | Dispatched when an HTTPService call fails. | Application
|  | exitState | Dispatched just before the component exits a view state. | UIComponent
|  | hide | Dispatched when an object's state changes from visible to invisible. | UIComponent
|  | initialize | Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent
|  | invalid | Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent
|  | invoke | Dispatched when an application is invoked. | WindowedApplication
|  | mouseDownOutside | Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent
|  | mouseWheelOutside | Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent
|  | move | Dispatched when the object has moved. | UIComponent
|  | moving | Dispatched before the WindowedApplication object moves, or while the WindowedApplication object is being dragged. | WindowedApplication
|  | networkChange | Dispatched when the computer connects to or disconnects from the network. | WindowedApplication
|  | preinitialize | Dispatched at the beginning of the component initialization sequence. | UIComponent
|  | remove | Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent
|  | resize | Dispatched when the component is resized. | UIComponent
|  | resizing | Dispatched before the WindowedApplication object is resized, or while the WindowedApplication object boundaries are being dragged. | WindowedApplication
|  | scroll | Dispatched when the user manually scrolls the container. | Container
|  | show | Dispatched when an object's state changes from invisible to visible. | UIComponent
|  | stateChangeComplete | Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent
|  | stateChangeInterrupted | Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent
|  | toolTipCreate | Dispatched by the component when it is time to create a ToolTip. | UIComponent
|  | toolTipEnd | Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent
|  | toolTipHide | Dispatched by the component when its ToolTip is about to be hidden. | UIComponent
|  | toolTipShow | Dispatched by the component when its ToolTip is about to be shown. | UIComponent
|  | toolTipShown | Dispatched by the component when its ToolTip has been shown. | UIComponent
|  | toolTipStart | Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent
|  | touchInteractionEnd | A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent
|  | touchInteractionStart | A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent
|  | touchInteractionStarting | A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent
|  | updateComplete | Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent
|  | valid | Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent
|  | valueCommit | Dispatched when values are changed programmatically or by user interaction. | UIComponent
|  | windowActivate | Dispatched after this application window has been activated. | WindowedApplication
|  | windowComplete | Dispatched when the WindowedApplication completes its initial layout. | WindowedApplication
|  | windowDeactivate | Dispatched after this application window has been deactivated. | WindowedApplication
|  | windowMove | Dispatched after the WindowedApplication object moves. | WindowedApplication
|  | windowResize | Dispatched after the underlying NativeWindow object is resized. | WindowedApplication

Styles
Hide Inherited Styles
Show Inherited Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | accentColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Accent color used by component skins. | Container
|  | backgroundAlpha | Type: 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
|  | backgroundAttachment | Type: 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
|  | backgroundColor | Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Background color of a component. | Container
|  | backgroundDisabledColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Background color of the component when it is disabled. | Container
|  | backgroundGradientAlphas | Type: Array CSS Inheritance: no Theme: halo Specifies the alpha transparency values used for the background gradient fill of the application. | Application
|  | backgroundGradientColors | Type: Array Format: Color CSS Inheritance: no Theme: halo Specifies the colors used to tint the background gradient fill of the application. | Application
|  | backgroundImage | Type: Object Format: File CSS Inheritance: no Theme: halo Background image of a component. | Container
|  | backgroundSize | Type: String CSS Inheritance: no Theme: halo Scales the image specified by `backgroundImage` to different percentage sizes. | Container
|  | barColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Determines the color of a ProgressBar. | Container
|  | baseline | Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent
|  | borderAlpha | Type: Number CSS Inheritance: no Theme: spark Alpha of the border. | Container
|  | borderColor | Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Color of the border. | Container
|  | borderSides | Type: String CSS Inheritance: no Theme: halo Bounding box sides. | Container
|  | borderSkin | Type: Class CSS Inheritance: no The border skin class of the component. | Container
|  | borderStyle | Type: String CSS Inheritance: no Bounding box style. | Container
|  | borderThickness | Type: Number Format: Length CSS Inheritance: no Theme: halo Bounding box thickness. | Container
|  | borderVisible | Type: Boolean CSS Inheritance: no Theme: spark Visibility of the border. | Container
|  | bottom | Type: 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"`. | WindowedApplication
|  | buttonPadding | Type: Number CSS Inheritance: yes Defines the distance between the titleBar buttons. The default value is`2`. | WindowedApplication
|  | chromeColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | UIComponent
|  | closeButtonSkin | Type: Class CSS Inheritance: no Skin for close button when using Flex chrome. The default value is`mx.skins.halo.WindowCloseButtonSkin`. | WindowedApplication
|  | color | Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | Container
|  | contentBackgroundAlpha | Type: Number CSS Inheritance: yes Theme: spark The alpha of the content background for this component. | Container
|  | contentBackgroundColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the content area of the component. | Container
|  | cornerRadius | Type: Number Format: Length CSS Inheritance: no Theme: halo, spark Radius of component corners. | Container
|  | direction | Type: String CSS Inheritance: yes The directionality of the text displayed by the component. | Container
|  | disabledColor | Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | Container
|  | disabledOverlayAlpha | Type: Number CSS Inheritance: no The alpha value for the overlay that is placed on top of the container when it is disabled. | Container
|  | dropShadowColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Color of the drop shadow. | Container
|  | dropShadowEnabled | Type: Boolean CSS Inheritance: no Theme: halo Boolean property that specifies whether the component has a visible drop shadow. | Container
|  | dropShadowVisible | Type: Boolean CSS Inheritance: no Theme: spark Boolean property that specifies whether the component has a visible drop shadow. | Container
|  | errorColor | Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent
|  | focusBlendMode | Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent
|  | focusColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus. | Container
|  | focusSkin | Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent
|  | focusThickness | Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent
|  | fontAntiAliasType | Type: String CSS Inheritance: yes Sets the `antiAliasType` property of internal TextFields. See also flash.text.TextField flash.text.AntiAliasType | Container
|  | fontFamily | Type: String CSS Inheritance: yes Name of the font to use. | Container
|  | fontGridFitType | Type: String CSS Inheritance: yes Sets the `gridFitType` property of internal TextFields that represent text in Flex controls. See also flash.text.TextField flash.text.GridFitType | Container
|  | fontSharpness | Type: Number CSS Inheritance: yes Sets the `sharpness` property of internal TextFields that represent text in Flex controls. See also flash.text.TextField | Container
|  | fontSize | Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | Container
|  | fontStyle | Type: String CSS Inheritance: yes Determines whether the text is italic font. | Container
|  | fontThickness | Type: Number CSS Inheritance: yes Sets the `thickness` property of internal TextFields that represent text in Flex controls. See also flash.text.TextField | Container
|  | fontWeight | Type: 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`. | WindowedApplication
|  | gripperStyleName | Type: String CSS Inheritance: no Style declaration for the skin of the gripper. The default value is`"gripperStyle"`. | WindowedApplication
|  | 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`. | WindowedApplication
|  | horizontalAlign | Type: String CSS Inheritance: no Horizontal alignment of children in the container. | LayoutContainer
|  | horizontalCenter | Type: 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
|  | horizontalGap | Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the horizontal direction. | LayoutContainer
|  | horizontalScrollBarStyleName | Type: String CSS Inheritance: no The name of the horizontal scrollbar style. | Container
|  | interactionMode | Type: String CSS Inheritance: yes The primary interaction mode for this component. See also mx.core.InteractionMode.MOUSE mx.core.InteractionMode.TOUCH | UIComponent
|  | kerning | Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled (`true`) or disabled (`false`). | Container
|  | layoutDirection | Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also MXFTEText.css mx.core.ILayoutDirectionElement mx.core.LayoutDirection | UIComponent
|  | left | Type: 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
|  | letterSpacing | Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | Container
|  | locale | Type: 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`. | WindowedApplication
|  | minimizeButtonSkin | Type: Class CSS Inheritance: no Skin for minimize button when using Flex chrome. The default value is`mx.skins.halo.WindowMinimizeButtonSkin`. | WindowedApplication
|  | modalTransparency | Type: Number CSS Inheritance: yes Modality of components launched by the PopUp Manager is simulated by creating a large translucent overlay underneath the component. | Application
|  | modalTransparencyBlur | Type: Number CSS Inheritance: yes The blur applied to the application while a modal window is open. See also flash.filters.BlurFilter | Application
|  | modalTransparencyColor | Type: uint Format: Color CSS Inheritance: yes Color of the modal overlay layer. | Application
|  | modalTransparencyDuration | Type: Number Format: Time CSS Inheritance: yes Duration, in milliseconds, of the modal transparency effect that plays when a modal window opens or closes. | Application
|  | paddingBottom | Type: Number Format: Length CSS Inheritance: no Number of pixels between the application's bottom border and its content area. | Application
|  | paddingLeft | Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. | Container
|  | paddingRight | Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. | Container
|  | paddingTop | Type: Number Format: Length CSS Inheritance: no Number of pixels between the application's top border and its content area. | Application
|  | 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`. | WindowedApplication
|  | right | Type: 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
|  | shadowDirection | Type: String CSS Inheritance: no Theme: halo Direction of the drop shadow. | Container
|  | shadowDistance | Type: Number Format: Length CSS Inheritance: no Theme: halo Distance of the drop shadow. | Container
|  | showErrorSkin | Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent
|  | showErrorTip | Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | 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`. | WindowedApplication
|  | statusBarBackgroundColor | Type: uint Format: Color CSS Inheritance: yes The colors used to draw the status bar. The default value is`0xC0C0C0`. | WindowedApplication
|  | statusBarBackgroundSkin | Type: Class CSS Inheritance: yes The status bar background skin. The default value is`mx.skins.halo.StatusBarBackgroundSkin`. | WindowedApplication
|  | statusTextStyleName | Type: String CSS Inheritance: yes Style declaration for the status text. The default value is`undefined`. | WindowedApplication
|  | symbolColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. | Container
|  | textAlign | Type: String CSS Inheritance: yes Alignment of text within a container. | Container
|  | textDecoration | Type: String CSS Inheritance: yes Determines whether the text is underlined. | Container
|  | textFieldClass | Type: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. | Container
|  | textIndent | Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | Container
|  | themeColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent
|  | 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"`. | WindowedApplication
|  | titleBarBackgroundSkin | Type: Class CSS Inheritance: yes The title background skin. The default value is`mx.skins.halo.ApplicationTitleBarBackgroundSkin`. | WindowedApplication
|  | 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`. | WindowedApplication
|  | 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 ]`. | WindowedApplication
|  | titleTextStyleName | Type: String CSS Inheritance: yes The style name for the title text. The default value is`undefined`. | WindowedApplication
|  | top | Type: 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
|  | verticalAlign | Type: String CSS Inheritance: no Vertical alignment of children in the container. | LayoutContainer
|  | verticalCenter | Type: 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
|  | verticalGap | Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the vertical direction. | LayoutContainer
|  | verticalScrollBarStyleName | Type: String CSS Inheritance: no The name of the vertical scrollbar style. | Container

Effects
Hide Inherited Effects
Show Inherited Effects

| Effect | Description | Defined By
--- | --- | --- | ---
|  | addedEffect | 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. | WindowedApplication
|  | creationCompleteEffect | Triggering Event: creationComplete Played when the component is created. | UIComponent
|  | focusInEffect | Triggering Event: focusIn Played when the component gains keyboard focus. | UIComponent
|  | focusOutEffect | Triggering Event: focusOut Played when the component loses keyboard focus. | UIComponent
|  | hideEffect | Triggering Event: hide Played when the component becomes invisible. | UIComponent
|  | minimizeEffect | Triggering Event: windowMinimize Played when the component is minimized. | WindowedApplication
|  | mouseDownEffect | Triggering Event: mouseDown Played when the user presses the mouse button while over the component. | UIComponent
|  | mouseUpEffect | Triggering Event: mouseUp Played when the user releases the mouse button while over the component. | UIComponent
|  | removedEffect | Triggering Event: removed Played when the component is removed from a Container. | UIComponent
|  | resizeEffect | Triggering Event: resize Played when the component is resized. | UIComponent
|  | rollOutEffect | Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component. | UIComponent
|  | rollOverEffect | Triggering Event: rollOver Played when the user rolls the mouse over the component. | UIComponent
|  | showEffect | Triggering Event: show Played when the component becomes visible. | UIComponent
|  | unminimizeEffect | Triggering Event: windowUnminimize Played when the component is unminimized. | WindowedApplication

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | DEFAULT_MAX_HEIGHT : Number = 10000 [static] The default value for the maxHeight property. | UIComponent
|  | DEFAULT_MAX_WIDTH : Number = 10000 [static] The default value for the maxWidth property. | UIComponent
|  | DEFAULT_MEASURED_HEIGHT : Number = 22 [static] The default value for the measuredHeight property. | UIComponent
|  | DEFAULT_MEASURED_MIN_HEIGHT : Number = 22 [static] The default value for the measuredMinHeight property. | UIComponent
|  | DEFAULT_MEASURED_MIN_WIDTH : Number = 40 [static] The default value for the measuredMinWidth property. | UIComponent
|  | DEFAULT_MEASURED_WIDTH : Number = 160 [static] The default value for the measuredWidth property. | UIComponent

Property Detail

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.

The default value is `false`.

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

applicationID | property |

`applicationID:String` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

The identifier that AIR uses to identify the application.

Implementation
`public function get applicationID():String`

autoExit | property |

`autoExit:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Specifies whether the AIR application will quit when the last window closes or will continue running in the background.

The default value is `true`.

Implementation
`public function get autoExit():Boolean`
`public function set autoExit(value:Boolean):void`

backgroundFrameRate | property |

`backgroundFrameRate:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | AIR 1.5

Specifies the frame rate to use when the application is inactive. When set to -1, no background frame rate throttling occurs.

The default value is `-1`.

Implementation
`public function get backgroundFrameRate():Number`
`public function set backgroundFrameRate(value:Number):void`

closed | property |

`closed:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Returns true when the underlying window has been closed.

Implementation
`public function get closed():Boolean`

dockIconMenu | property |

`dockIconMenu:FlexNativeMenu`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

The dock icon menu. Some operating systems do not support dock icon menus.

Implementation
`public function get dockIconMenu():FlexNativeMenu`
`public function set dockIconMenu(value:FlexNativeMenu):void`

maximizable | property |

`maximizable:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Specifies whether the window can be maximized.

Implementation
`public function get maximizable():Boolean`

menu | property |

`menu:FlexNativeMenu`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

The application menu for operating systems that support an application menu, or the window menu of the application's initial window for operating systems that support window menus.

Implementation
`public function get menu():FlexNativeMenu`
`public function set menu(value:FlexNativeMenu):void`

minimizable | property |

`minimizable:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Specifies whether the window can be minimized.

Implementation
`public function get minimizable():Boolean`

nativeApplication | property |

`nativeApplication:NativeApplication` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

The NativeApplication object representing the AIR application.

Implementation
`public function get nativeApplication():NativeApplication`

nativeWindow | property |

`nativeWindow:NativeWindow` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

The NativeWindow used by this WindowedApplication component (the initial native window of the application).

Implementation
`public function get nativeWindow():NativeWindow`

resizable | property |

`resizable:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Specifies whether the window can be resized.

Implementation
`public function get resizable():Boolean`

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`

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`

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`

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.

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

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`

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.

Implementation
`public function get statusBarFactory():IFactory`
`public function set statusBarFactory(value:IFactory):void`

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 WindowedApplication to the status bar.

Implementation
`protected function get statusBarStyleFilters():Object`

See also

mx.styles.StyleProxy

systemChrome | property |

`systemChrome:String` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

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

Implementation
`public function get systemChrome():String`

See also

flash.display.NativeWindow.systemChrome

systemTrayIconMenu | property |

`systemTrayIconMenu:FlexNativeMenu`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

The system tray icon menu. Some operating systems do not support system tray icon menus.

Implementation
`public function get systemTrayIconMenu():FlexNativeMenu`
`public function set systemTrayIconMenu(value:FlexNativeMenu):void`

title | property |

`title:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

The title that appears in the window title bar and the taskbar. If you are using system chrome and you set this property to something different than the <title> tag in your application.xml, you may see the title from the XML file appear briefly first.

The default value is `""`.

This property can be used as the source for data binding.

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

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`

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.

Implementation
`public function get titleBarFactory():IFactory`
`public function set titleBarFactory(value:IFactory):void`

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 WindowedApplication to the titleBar.

Implementation
`protected function get titleBarStyleFilters():Object`

See also

mx.styles.StyleProxy

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.

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

transparent | property |

`transparent:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Specifies whether the window is transparent.

Implementation
`public function get transparent():Boolean`

type | property |

`type:String` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

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

Implementation
`public function get type():String`

See also

flash.display.NativeWindowType

useNativeDragManager | property |

`public var useNativeDragManager:Boolean = true`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

If `true`, the DragManager should use the NativeDragManagerImpl implementation class. If `false`, then the DragManagerImpl class will be used.

Note: This property cannot be set by ActionScript code; it must be set in MXML code. That means you cannot change its value at run time.

By default, the DragManager for AIR applications built in Flex uses the NativeDragManagerImpl class as the implementation class. Flash Player applications build in Flex use the DragManagerImpl class.

The NativeDragManagerImpl class is a bridge between the AIR NativeDragManager API and the Flex DragManager API. The AIR NativeDragManager class uses the operating system's drag and drop APIs. It supports dragging between AIR windows and between the operating system and AIR. Because the operating system controls the drag-and-drop operation, it is not possible to customize the cursors during a drag. Also, you have no control over the drop animation. The behavior is dependent upon the operating system and has some inconsistencies across different platforms.

The DragManagerImpl class does not use the operating system for drag-and-drop. Instead, it controls the entire drag-and-drop process. It supports customizing the cursors and provides a drop animation. However, it does not allow dragging between AIR windows and between the operating system or AIR window.

The default value is `true`.

Constructor Detail

WindowedApplication | () | Constructor

`public function WindowedApplication()`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Constructor.

Method Detail

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 application is not the active one).

close | () | method |

`public function close():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Closes the application's NativeWindow (the initial native window opened by the application). This action is cancelable.

exit | () | method |

`public function exit():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Closes the window and exits the application.

maximize | () | method |

`public function maximize():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

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

minimize | () | method |

`public function minimize():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Minimizes the window.

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

| `Boolean` — `true` if the window was succesfully sent behind; `false` if the window is invisible or minimized.

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

| `Boolean` — `true` if the window was succesfully sent in front; `false` if the window is invisible or minimized.

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

| `Boolean` — `true` if the window was succesfully sent to the back; `false` if the window is invisible or minimized.

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

| `Boolean` — `true` if the window was succesfully sent to the front; `false` if the window is invisible or minimized.

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

applicationActivate | Event

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Dispatched when this application is 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:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The 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`.
`file` | The File object associated with this event.
`target` | The 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.
`type` | AIREvent.APPLICATION_ACTIVATE

applicationDeactivate | Event |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Dispatched when this application is 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:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The 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`.
`file` | The File object associated with this event.
`target` | The 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.
`type` | AIREvent.APPLICATION_DEACTIVATE

close | Event |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Dispatched after this application window has been closed.

See also

flash.display.NativeWindow

closing | Event |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Dispatched before the WindowedApplication window closes. Cancelable.

See also

flash.display.NativeWindow

displayStateChange | Event |

Event Object Type: `flash.events.NativeWindowDisplayStateEvent`
NativeWindowDisplayStateEvent.type property = `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.

displayStateChanging | Event |

Event Object Type: `flash.events.NativeWindowDisplayStateEvent`
NativeWindowDisplayStateEvent.type property = `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.

invoke | Event |

Event Object Type: `flash.events.InvokeEvent`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Dispatched when an application is invoked.

moving | Event |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Dispatched before the WindowedApplication object moves, or while the WindowedApplication object is being dragged.

networkChange | Event |

Event Object Type: `flash.events.Event`
Event.type property = `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.

resizing | Event |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Dispatched before the WindowedApplication object is resized, or while the WindowedApplication object boundaries are being dragged.

windowActivate | Event |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Dispatched after this application 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:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The 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`.
`file` | The File object associated with this event.
`target` | The 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.
`type` | AIREvent.WINDOW_ACTIVATE

windowComplete | Event |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Dispatched when the WindowedApplication completes its initial layout. By default, the WindowedApplication will be visbile at this time.

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:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The 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`.
`file` | The File object associated with this event.
`target` | The 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.
`type` | AIREvent.WINDOW_COMPLETE

windowDeactivate | Event |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Dispatched after this application 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:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The 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`.
`file` | The File object associated with this event.
`target` | The 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.
`type` | AIREvent.WINDOW_DEACTIVATE

windowMove | Event |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Dispatched after the WindowedApplication object 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:

Property | Value
--- | ---
`afterBounds` | The bounds of the window after the bounds changed.
`beforeBounds` | The bounds of the window before the bounds changed.
`bubbles` | false
`cancelable` | false
`currentTarget` | The 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`.
`file` | The File object associated with this event.
`target` | The 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.
`type` | FlexNativeWindowBoundsEvent.WINDOW_MOVE

windowResize | Event |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | AIR 1.1

Dispatched after the underlying NativeWindow object 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:

Property | Value
--- | ---
`afterBounds` | The bounds of the window after the bounds changed.
`beforeBounds` | The bounds of the window before the bounds changed.
`bubbles` | false
`cancelable` | false
`currentTarget` | The 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`.
`file` | The File object associated with this event.
`target` | The 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.
`type` | FlexNativeWindowBoundsEvent.WINDOW_RESIZE

Wed Nov 15 2017, 09:50 AM +01:00