Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
spark.components 
WindowedApplication 
Packagespark.components
Classpublic class WindowedApplication
InheritanceWindowedApplication Inheritance Application Inheritance SkinnableContainer Inheritance SkinnableContainerBase Inheritance SkinnableComponent Inheritance UIComponent Inheritance FlexSprite Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IWindow

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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:WindowedApplication> 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 SyntaxexpandedHide MXML Syntax

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

  <s:WindowedApplication
    Properties
    alwaysInFront="false"
    autoExit="true"
    backgroundFrameRate="-1"
    dockIconMenu="null"
    menu="null"
    showStatusBar="true"
    status=""
    systemTrayIconMenu="null"
    title=""
    titleIcon="null"
    useNativeDragManager="true"
 
    Styles
    backgroundAlpha="1.0"
    backgroundColor="0xFFFFFF"
    resizeAffordanceWidth="6"
 
    Effects
    closeEffect="No default"
    minimizeEffect="No default"
    unminimizeEffect="No default"
 
    Events
    applicationActivate="No default"
    applicationDeactivate="No default"
    close="No default"
    closing="No default"
    displayStateChange="No default"
    displayStateChanging="No default"
    invoke="No default"
    moving="No default"
    networkChange="No default"
    resizing="No default"
    windowActivate="No default"
    windowComplete="No default"
    windowDeactivate="No default"
    windowMove="No default"
    windowResize="No default"
  />
  

Default MXML PropertymxmlContentFactory

View the examples

See also



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

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

Common Styles
 Style Description Defined By
 InheritedType: String CSS Inheritance: yes
Specifies the baseline to which the dominant baseline aligns.
SkinnableContainer
  
backgroundAlpha
Type: Number CSS Inheritance: no
Alpha level of the color defined by the backgroundColor property. The default value is 1.0.
WindowedApplication
  
backgroundColor
Type: uint Format: Color CSS Inheritance: no
The background color of the application. This color is used as the stage color for the application and the background color for the HTML embed tag.
WindowedApplication
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the top edge of the content area to the control's baseline position.
UIComponent
 InheritedType: Object CSS Inheritance: yes
Amount to shift the baseline from the dominantBaseline value.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Specifies a vertical or horizontal progression of line placement.
SkinnableContainer
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.
UIComponent
 InheritedType: String CSS Inheritance: yes
Controls where lines are allowed to break when breaking wrapping text into multiple lines.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
The type of CFF hinting used for this text.
SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of the text.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
The type of digit case used for this text.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Type of digit width used for this text.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Specifies the default bidirectional embedding level of the text in the text block.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line.
SkinnableContainer
 InheritedType: Class
Name of the skin class to use for this component when a validation error occurs.
SkinnableComponent
 InheritedType: Object CSS Inheritance: yes
Specifies the baseline position of the first line in the container.
SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of text when the component is enabled and has focus.
SkinnableContainer
 InheritedType: Class CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
 InheritedType: String CSS Inheritance: yes
The name of the font to use, or a comma-separated list of font names.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Font lookup to use.
SkinnableContainer
 InheritedType: Number Format: Length CSS Inheritance: yes
The size of the text in pixels.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Style of text.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Weight of text.
SkinnableContainer
 InheritedType: String CSS Inheritance: no
The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of text when the component is disabled.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Rule used to justify text in a paragraph.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
The style used for justification of the paragraph.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Specifies the desired layout direction of a component.
UIComponent
 InheritedType: String CSS Inheritance: yes
Specifies the leading model, which is a combination of leading basis and leading direction.
SkinnableContainer
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.
UIComponent
 InheritedType: String CSS Inheritance: yes
Controls which of the ligatures that are defined in the font may be used in the text.
SkinnableContainer
 InheritedType: Object CSS Inheritance: yes
Leading controls for the text.
SkinnableContainer
 InheritedType: Boolean CSS Inheritance: yes
If true, applies strikethrough, a line drawn through the middle of the text.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
The locale of the text.
SkinnableContainer
 InheritedType: Number Format: length CSS Inheritance: yes
A Number that specifies, in pixels, the amount to indent the paragraph's end edge.
SkinnableContainer
 InheritedType: Number Format: length CSS Inheritance: yes
A Number that specifies the amount of space, in pixels, to leave after the paragraph.
SkinnableContainer
 InheritedType: Number Format: length CSS Inheritance: yes
A Number that specifies the amount of space, in pixels, to leave before the paragraph.
SkinnableContainer
 InheritedType: Number Format: length CSS Inheritance: yes
A Number that specifies, in pixels, the amount to indent the paragraph's start edge.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
The rendering mode used for this text.
SkinnableContainer
  
resizeAffordanceWidth
Type: Number Format: length CSS Inheritance: no
Provides a margin of error around a window's border so a resize can be more easily started. A click on a window is considered a click on the window's border if the click occurs with the resizeAffordance number of pixels from the outside edge of the window. The default value is 6.
WindowedApplication
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.
UIComponent
 InheritedType: Class
Name of the skin class to use for this component.
SkinnableComponent
 InheritedType: String CSS Inheritance: yes
Specifies the tab stops associated with the paragraph.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Alignment of lines in the paragraph relative to the container.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Alignment of the last (or only) line in the paragraph relative to the container in justified text.
SkinnableContainer
 InheritedType: Number CSS Inheritance: yes
Alpha (transparency) value for the text.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Decoration on text.
SkinnableContainer
 InheritedType: Number Format: Length CSS Inheritance: yes
A Number that specifies, in pixels, the amount to indent the first line of the paragraph.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Specifies options for justifying text.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
Determines the number of degrees to rotate this text.
SkinnableContainer
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area.
UIComponent
 InheritedType: Object CSS Inheritance: yes
Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character.
SkinnableContainer
 InheritedType: Object CSS Inheritance: yes
Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character.
SkinnableContainer
 InheritedType: String CSS Inheritance: yes
The type of typographic case used for this text.
SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of text when the component is enabled but does not have focus.
SkinnableContainer
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the center of the component's content area to the center of the component.
UIComponent
 InheritedType: String CSS Inheritance: yes
Collapses or preserves whitespace when importing text into a TextFlow.
SkinnableContainer
Spark Theme Styles
 Style Description Defined By
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Accent color used by component skins.
SkinnableContainer
 InheritedType: Array Format: Color CSS Inheritance: yes Theme: spark
The colors to use for the backgrounds of the items in the list.
SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
The main color for a component.
SkinnableComponent
 InheritedType: Number CSS Inheritance: yes Theme: spark
The alpha of the content background for this component.
SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of the fill of an item renderer.
SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of focus ring when the component is in focus.
SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of the highlights when the mouse is over the component.
SkinnableContainer
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of any symbol of a component.
SkinnableContainer
Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.


 Skin Part Description Defined By
 InheritedRequired: false Part Type: Static
An optional skin part that defines the Group where the content children get pushed into and laid out.
SkinnableContainer
 InheritedRequired: false Part Type: Static
The skin part that defines the appearance of the control bar area of the container. By default, the ApplicationSkin class defines the control bar area to appear at the top of the content area of the Application container with a grey background.
Application
  
gripper:Button
Required: false Part Type: Static
The skin part that defines the gripper button used to resize the window.
WindowedApplication
  
statusBar:IVisualElement
Required: false Part Type: Static
The skin part that defines the display of the status bar.
WindowedApplication
  
statusText:TextBase
Required: false Part Type: Static
The skin part that defines the display of the status bar's text.
WindowedApplication
  
titleBar:TitleBar
Required: false Part Type: Static
The skin part that defines the display of the title bar.
WindowedApplication
Skin States

To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.


 Skin State Description Defined By
 Inherited Disabled State SkinnableContainerBase
  
disabledAndInactive
The application is disabled and inactive. WindowedApplication
 Inherited Normal State SkinnableContainerBase
  
normalAndInactive
The application is enabled and inactive. WindowedApplication
Effects
 Effect Description Defined By
 Inherited Triggering Event: added
Played when the component is added as a child to a Container.
UIComponent
  
closeEffect
Triggering Event: windowClose
Played when the window is closed.
WindowedApplication
 Inherited Triggering Event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering Event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering Event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering Event: hide
Played when the component becomes invisible.
UIComponent
  
minimizeEffect
Triggering Event: windowMinimize
Played when the component is minimized.
WindowedApplication
 Inherited Triggering Event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering Event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering Event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering Event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering Event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering Event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering Event: show
Played when the component becomes visible.
UIComponent
  
unminimizeEffect
Triggering Event: windowUnminimize
Played when the component is unminimized.
WindowedApplication
Public Constants
 ConstantDefined By
 InheritedDEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
 InheritedDEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
Property Detail
AIR-only 

alwaysInFront

property
alwaysInFront:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

applicationID

property 
applicationID:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

The identifier that AIR uses to identify the application.



Implementation
    public function get applicationID():String
AIR-only 

autoExit

property 
autoExit:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

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

closed

property 
closed:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Returns true when the underlying window has been closed.



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

dockIconMenu

property 
dockIconMenu:FlexNativeMenu

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

maximizable

property 
maximizable:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Specifies whether the window can be maximized.



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

menu

property 
menu:FlexNativeMenu

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

minimizable

property 
minimizable:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Specifies whether the window can be minimized.



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

nativeApplication

property 
nativeApplication:NativeApplication  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

The NativeApplication object representing the AIR application.



Implementation
    public function get nativeApplication():NativeApplication
AIR-only 

nativeWindow

property 
nativeWindow:NativeWindow  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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



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

resizable

property 
resizable:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Specifies whether the window can be resized.



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

showStatusBar

property 
showStatusBar:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

If true, the status bar is visible.

The status bar only appears when you use the WindowedApplicationSkin class or the SparkChromeWindowedApplicationSkin class as the skin for your application or any of your application's windows.

The default value is true.



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

status

property 
status:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

The default value is "".

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



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

systemChrome

property 
systemChrome:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

AIR-only 

systemTrayIconMenu

property 
systemTrayIconMenu:FlexNativeMenu

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

title

property 
title:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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. When this property is modified, it dispatches the titleChanged event.



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

titleIcon

property 
titleIcon:Class

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

The default value is null.

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



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

transparent

property 
transparent:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Specifies whether the window is transparent.



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

type

property 
type:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

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

WindowedApplication

()Constructor
public function WindowedApplication()

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Constructor.

Method Detail

AIR-only activate

()method
public function activate():void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Activates the underlying NativeWindow (even if this application is not the active one).

AIR-only close

()method 
public function close():void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

AIR-only exit

()method 
public function exit():void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Closes the window and exits the application.

AIR-only maximize

()method 
public function maximize():void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

AIR-only minimize

()method 
public function minimize():void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Minimizes the window.

AIR-only mouseDownHandler

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Manages mouse down events on the window border.

Parameters

event:MouseEvent

AIR-only orderInBackOf

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

Parameters

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

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

AIR-only orderInFrontOf

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

Parameters

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

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

AIR-only orderToBack

()method 
public function orderToBack():Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Orders the window behind all others in the same application.

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

AIR-only orderToFront

()method 
public function orderToFront():Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

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

AIR-only restore

()method 
public function restore():void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

Event Detail
AIR-only 

applicationActivate

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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:

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

applicationDeactivate

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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:

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

close

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Dispatched after this application window has been closed.

The Event.CLOSE constant defines the value of the type property of a close event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object whose connection has been closed.

See also

AIR-only 

closing

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Dispatched before the WindowedApplication window closes. Cancelable.

The Event.CLOSING constant defines the value of the type property of a closing event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelabletrue; canceling this event object stops the close operation.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object whose connection is to be closed.

See also

AIR-only 

displayStateChange

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

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

This event has the following properties:

PropertiesValues
afterDisplayStateThe old display state of the window.
beforeDisplayStateThe new display state of the window.
targetThe NativeWindow instance that has just changed state.
bubblesNo.
currentTargetIndicates the object that is actively processing the Event object with an event listener.
cancelablefalse; There is no default behavior to cancel.
AIR-only 

displayStateChanging

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

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

This event has the following properties:

PropertiesValues
afterDisplayStateThe display state of the window before the pending change.
beforeDisplayStateThe display state of the window after the pending change.
targetThe NativeWindow instance that has just changed state.
bubblesNo.
currentTargetIndicates the object that is actively processing the Event object with an event listener.
cancelabletrue; canceling the event will prevent the change.
AIR-only 

invoke

Event  
Event Object Type: flash.events.InvokeEvent

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Dispatched when an application is invoked.

AIR-only 

moving

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

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

This event has the following properties:

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

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

AIR-only 

networkChange

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe NativeApplication object.
AIR-only 

resizing

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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

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

This event has the following properties:

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

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

AIR-only 

windowActivate

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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:

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

windowComplete

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

Dispatched when the WindowedApplication completes its initial layout. By default, the WindowedApplication will be visible 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:

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

windowDeactivate

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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:

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

windowMove

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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:

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

windowResize

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

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: AIR 1.5

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:

PropertyValue
afterBoundsThe bounds of the window after the bounds changed.
beforeBoundsThe bounds of the window before the bounds changed.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
fileThe File object associated with this event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeFlexNativeWindowBoundsEvent.WINDOW_RESIZE
WindowedApplicationSample.mxml
<?xml version="1.0" encoding="utf-8"?>
<s:WindowedApplication
    xmlns:fx="http://ns.adobe.com/mxml/2009"
    xmlns:mx="library://ns.adobe.com/flex/mx"
    xmlns:s="library://ns.adobe.com/flex/spark"
    creationComplete="doCreationComplete();">

    <fx:Script>
        <![CDATA[
            import mx.controls.FlexNativeMenu;
            import mx.events.FlexNativeMenuEvent;

            [Embed(source="TestImage.jpg")]
            [Bindable]
            public var TestImage:Class;

            private var menu1:FlexNativeMenu;
            private var menu2:FlexNativeMenu;

            /**
             * Set up the icon and menus.
             **/
            private function doCreationComplete():void {
                setUpIcon();
            
                menu1 = new FlexNativeMenu();
                menu1.addEventListener(mx.events.FlexNativeMenuEvent.ITEM_CLICK, handleMenuItemClick);
                menu1.dataProvider = menuData1;
                menu1.labelField = "@label";
                menu1.showRoot = false;

                menu2 = new FlexNativeMenu();
                menu2.addEventListener(mx.events.FlexNativeMenuEvent.ITEM_CLICK, handleMenuItemClick);
                menu2.dataProvider = menuData2;
                menu2.labelField = "@label";
                menu2.showRoot = false;

                // Mac dock
                dockIconMenu = menu1;
        
                // Windows system tray
                systemTrayIconMenu = menu1;
        
                // Mac and Windows
                menu = menu2;
            }

            /**
             * Set up the icon which appears in the sytem tray (Win)
             * or the dock (Mac).
             **/
            private function setUpIcon():void {
                nativeApplication.icon.bitmaps = new Array(new TestImage().bitmapData);
            }

            /**
             * If someone chooses Exit from either menu, then exit.
             **/
            private function handleMenuItemClick(e:mx.events.FlexNativeMenuEvent):void { 
                if(e.label == "Exit"){
                    exit();
                }
            }
        ]]>
    </fx:Script>

    <fx:Declarations>
        <!-- We use this one for the system tray or dock. -->
        <fx:XML format="e4x" id="menuData1">
            <root>
                <menuitem label="Exit" />
            </root>
        </fx:XML>

        <!-- We use this one for the menu on top. -->
        <fx:XML format="e4x" id="menuData2">
            <root>
                <menuitem label="File" >
                    <menuitem label="Exit" />
                </menuitem>
            </root>
        </fx:XML>
    </fx:Declarations>
</s:WindowedApplication>