Packagemx.core
Classpublic class Application
InheritanceApplication Inheritance LayoutContainer Inheritance Container Inheritance UIComponent Inheritance FlexSprite Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Subclasses WindowedApplication

Flex defines a default, or Application, container that lets you start adding content to your application without explicitly defining another container. Flex creates this container from the <mx:Application> tag, the first tag in an MXML application file. While you might find it convenient to use the Application container as the only container in your application, in most cases you explicitly define at least one more container before you add any controls to your application.

Applications support a predefined plain style that sets a white background, left alignment, and removes all margins. To use this style, do the following:

    <mx:Application styleName="plain" />
  

This is equivalent to setting the following style attributes:

    backgroundColor="0xFFFFFF"
    horizontalAlign="left"
    paddingLeft="0"
    paddingTop="0"
    paddingBottom="0"
    paddingRight="0"
  

MXML SyntaxexpandedHide MXML Syntax

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

  <mx:Application
    Properties
    application="No default"
    controlBar="null"
    frameRate="24"
    historyManagementEnabled="true|false"
    layout="vertical|horizontal|absolute"
    pageTitle"No default"
    preloader="No default"
    resetHistory="false|true"
    scriptRecursionLimit="1000"
    scriptTimeLimit="60"
    usePreloader="true|false"
    viewSourceURL=""
    xmlns:No default="No default"
 
    Styles 
    backgroundGradientAlphas="[ 1.0, 1.0 ]"
    backgroundGradientColors="undefined"
    horizontalAlign="center|left|right"
    horizontalGap="8"
    modalTransparency="0.5"
    modalTransparencyBlur="3"
    modalTransparencyColor="#DDDDDD"
    modalTransparencyDuration="100"
    paddingBottom="24"
    paddingTop="24"
    verticalAlign="top|bottom|middle"
    verticalGap="6"
  
    Events
    applicationComplete="No default"
    error="No default"
  />
  

View the examples

See also

mx.managers.CursorManager
mx.managers.LayoutManager
mx.managers.SystemManager
flash.events.EventDispatcher
About the Application container
Dynamically adding containers to the queue


Public Properties
 PropertyDefined By
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 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
  application : Object
[static] [read-only] A reference to the top-level application.
Application
 InheritedautoLayout : Boolean
If true, measurement and layout are done when the position or size of a child is changed.
Container
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
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
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedblendShader : Shader
[write-only] Sets a shader that is used for blending the foreground and background.
DisplayObject
 InheritedborderMetrics : EdgeMetrics
[read-only] Returns an EdgeMetrics object that has four properties: left, top, right, and bottom.
Container
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the display object.
DisplayObject
 InheritedcacheHeuristic : Boolean
[write-only] Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
 InheritedchildDescriptors : Array
[read-only] Array of UIComponentDescriptor objects produced by the MXML compiler.
Container
 InheritedclassName : String
[read-only] The name of this instance's class, such as "Button".
UIComponent
 InheritedclipContent : Boolean
Whether to apply a clip mask if the positions and/or sizes of this container's children extend outside the borders of this container.
Container
 InheritedconstraintColumns : Array
An Array of ConstraintColumn instances that partition this container.
LayoutContainer
 InheritedconstraintRows : Array
An Array of ConstraintRow instances that partition this container.
LayoutContainer
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcontentMouseX : Number
[override] [read-only] Returns the x position of the mouse, in the content coordinate system.
Container
 InheritedcontentMouseY : Number
[override] [read-only] Returns the y position of the mouse, in the content coordinate system.
Container
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
  controlBar : IUIComponent
The ApplicationControlBar for this Application.
Application
 InheritedcreatingContentPane : Boolean
Containers use an internal content pane to control scrolling.
Container
 InheritedcreationIndex : int
Specifies the order to instantiate and draw the children of the container.
Container
 InheritedcreationPolicy : String
The child creation policy for this Container.
Container
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
[read-only] Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
 Inheriteddata : Object
The data property lets you pass a value to the component when you use it in an item renderer or item editor.
Container
 InheriteddefaultButton : IFlexDisplayObject
The Button control designated as the default button for the container.
Container
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
[override] Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 InheriteddropTarget : DisplayObject
[read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.
Sprite
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
UIComponent
 InheritederrorString : String
The text that will be 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
  frameRate : 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
 Inheritedheight : Number
[override] Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
  historyManagementEnabled : Boolean = true
If false, the history manager will be disabled.
Application
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
 InheritedhorizontalLineScrollSize : Number
Number of pixels to move when the left- or right-arrow button in the horizontal scroll bar is pressed.
Container
 InheritedhorizontalPageScrollSize : Number
Number of pixels to move when the track in the horizontal scroll bar is pressed.
Container
 InheritedhorizontalScrollBar : ScrollBar
The horizontal scrollbar used in this container.
Container
 InheritedhorizontalScrollPolicy : String
Specifies whether the horizontal scroll bar is always present, always absent, or automatically added when needed.
Container
 InheritedhorizontalScrollPosition : Number
The current position of the horizontal scroll bar.
Container
 Inheritedid : String
ID of the component.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : Boolean
A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).
UIComponent
 InheritedinstanceIndex : int
[read-only] The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 InheritedisDocument : Boolean
[read-only] Determines whether this UIComponent instance is a document object, that is, whether it is at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.
UIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
 Inheritedlayout : String
Specifies the layout mechanism used for this application.
LayoutContainer
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
DisplayObject
 InheritedmaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedmaxHorizontalScrollPosition : Number
[read-only] The largest possible value for the horizontalScrollPosition property.
Container
 InheritedmaxVerticalScrollPosition : Number
[read-only] The largest possible value for the verticalScrollPosition property.
Container
 InheritedmaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
 InheritedminHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedminWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmoduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
UIComponent
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse messages.
InteractiveObject
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse position, in pixels.
DisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
 InheritednumAutomationChildren : int
[read-only] The number of automation children this container has.
UIComponent
 InheritednumChildren : int
[override] [read-only] Number of child components in this container.
Container
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 Inheritedowner : DisplayObjectContainer
The owner of this UIComponent.
UIComponent
  pageTitle : String
Specifies a string that appears in the title bar of the browser.
Application
  parameters : Object
[read-only] The parameters property returns an Object containing name-value pairs representing the parameters provided to this Application.
Application
 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
Number that specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
UIComponent
  preloader : Object
Specifies the path of a SWC component class or ActionScript component class that defines a custom progress bar.
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
 InheritedrawChildren : IChildList
[read-only] A container typically contains child components, which can be enumerated using the Container.getChildAt() method and Container.numChildren property.
Container
 Inheritedrepeater : IRepeater
[read-only] A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
[read-only] The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : Array
An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent.
UIComponent
 Inheritedrepeaters : Array
An Array containing references to the Repeater objects in the parent document that produced this UIComponent.
UIComponent
  resetHistory : Boolean = true
If true, the application's history state is reset to its initial state whenever the application is reloaded.
Application
 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
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
DisplayObject
 InheritedrotationX : Number
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
 InheritedrotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
 InheritedrotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
 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
Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
DisplayObject
 Inheritedscreen : Rectangle
[read-only] Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
  scriptRecursionLimit : int
Specifies the maximum depth of Flash Player or AIR call stack before the player stops.
Application
  scriptTimeLimit : Number
Specifies the maximum duration, in seconds, that an ActionScript event handler can execute before Flash Player or AIR assumes that it is hung, and aborts it.
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
 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
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtextSnapshot : flash.text:TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
 Inheritedtransform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
 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
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIComponent
 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
  url : 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 mouse rolls over a sprite in which the buttonMode property is set to true.
Sprite
  usePreloader : Boolean
If true, specifies to display the application preloader.
Application
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 InheritedverticalLineScrollSize : Number
Number of pixels to scroll when the up- or down-arrow button in the vertical scroll bar is pressed, or when you scroll by using the mouse wheel.
Container
 InheritedverticalPageScrollSize : Number
Number of pixels to scroll when the track in the vertical scroll bar is pressed.
Container
 InheritedverticalScrollBar : ScrollBar
The vertical scrollbar used in this container.
Container
 InheritedverticalScrollPolicy : String
Specifies whether the vertical scroll bar is always present, always absent, or automatically added when needed.
Container
 InheritedverticalScrollPosition : Number
The current position of the vertical scroll bar.
Container
 InheritedviewMetrics : EdgeMetrics
[read-only] Returns an object that has four properties: left, top, right, and bottom.
Container
 InheritedviewMetricsAndPadding : EdgeMetrics
[read-only] Returns an object that has four properties: left, top, right, and bottom.
Container
  viewSourceURL : String
URL where the application's source can be viewed.
Application
 Inheritedvisible : Boolean
[override] Controls the visibility of this UIComponent.
UIComponent
 Inheritedwidth : Number
[override] Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
 Inheritedz : Number
Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
DisplayObject
Protected Properties
 PropertyDefined By
 InheritedactualCreationPolicy : String
The creation policy of this container.
Container
 InheritedboxLayoutClass : Class
The mx.containers.utilityClasses.Layout subclass that is doing the layout
LayoutContainer
 InheritedcanvasLayoutClass : Class
The mx.containers.utilityClasses.Layout subclass that is doing the layout
LayoutContainer
 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.
Application
 Inherited
[override] Adds a child DisplayObject to this Container.
Container
 Inherited
[override] Adds a child DisplayObject to this Container.
Container
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
  
addToCreationQueue(id:Object, preferredIndex:int = -1, callbackFunc:Function = null, parent:IFlexDisplayObject = null):void
Add a container to the Application's creation queue.
Application
 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
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
[override] Converts a Point object from content coordinates to global coordinates.
Container
 Inherited
[override] Converts a Point object from content to local coordinates.
Container
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Given a single UIComponentDescriptor, create the corresponding component and add the component as a child of this Container.
Container
 Inherited
Iterate through the Array of childDescriptors, and call the createComponentFromDescriptor() method for each one.
Container
 Inherited
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
Programatically draws a rectangle into this skin's Graphics object.
UIComponent
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
Ends all currently playing effects on the component.
UIComponent
 Inherited
executeBindings(recurse:Boolean = false):void
[override] Executes all the data bindings on this Container.
Container
 Inherited
Executes the bindings into this Container's child UIComponent objects.
Container
 Inherited
Called after printing is complete.
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
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
[override] Gets the nth child component object.
Container
 Inherited
[override] Returns the child whose name property is the specified String.
Container
 Inherited
[override] Gets the zero-based index of a specific child.
Container
 Inherited
Returns an Array of DisplayObject objects consisting of the content children of the container.
Container
 Inherited
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
UIComponent
 Inherited
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
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
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
[override] Converts a Point object from global to content coordinates.
Container
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.
DisplayObject
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
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
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
DisplayObject
 Inherited
[override] Converts a Point object from local to content coordinates.
Container
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
Measures the specified HTML text, which may 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 using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
Moves the component to a specified position within its parent.
UIComponent
 Inherited
Propagates style changes to the children.
UIComponent
 Inherited
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well.
UIComponent
 Inherited
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
Removes all children from the child list of this container.
Container
 Inherited
[override] Removes a child DisplayObject from the child list of this Container.
Container
 Inherited
[override] Removes a child DisplayObject from the child list of this Container at the specified index.
Container
 Inherited
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
 Inherited
[static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().
UIComponent
 Inherited
Sizes the object.
UIComponent
 Inherited
[override] Sets the index of a particular child.
Container
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
Sets the focus to this component.
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
Ends the startDrag() method.
Sprite
 Inherited
Detects changes to style properties.
UIComponent
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
Swaps the z-order (front-to-back order) of the two specified child objects.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
DisplayObjectContainer
 Inherited
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
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
[override] Used internally by the Dissolve Effect to add the overlay to the chrome of a container.
Container
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
Processes the properties set on the component.
UIComponent
 Inherited
Creates the container's border skin if it is needed and does not already exist.
Container
 Inherited
Create child objects of the component.
UIComponent
 Inherited
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
Creates the object using a given moduleFactory.
UIComponent
 Inherited
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
The event handler called for a keyDown event.
UIComponent
 Inherited
The event handler called for a keyUp event.
UIComponent
 Inherited
layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
Respond to size changes by setting the positions and sizes of this container's borders.
Container
 Inherited
Calculates the default size, and optionally the default minimum size, of the component.
UIComponent
 Inherited
This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.
UIComponent
 Inherited
Positions the container's content area relative to the viewable area based on the horizontalScrollPosition and verticalScrollPosition properties.
Container
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override] Respond to size changes by setting the positions and sizes of this container's children.
Container
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 InheritedDispatched when the component is added to a container as a content child by using the addChild() or addChildAt() 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 after the Application has been initialized, processed by the LayoutManager, and attached to the display list.Application
 InheritedDispatched after a child has been added to a container.Container
 InheritedDispatched after the index (among the container children) of a container child changes.Container
 InheritedDispatched before a child of a container is removed.Container
 InheritedDispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 InheritedDispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.InteractiveObject
 InheritedDispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 InheritedDispatched after the view state has changed.UIComponent
 InheritedDispatched after the currentState property changes, but before the view state changes.UIComponent
 InheritedDispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.InteractiveObject
 InheritedDispatched when the data property changes.Container
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 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
 Inherited[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
 InheritedDispatched after the component has returned to the root view state.UIComponent
  Dispatched when an error occurs anywhere in the application, such as an HTTPService, WebService, or RemoteObject fails.Application
 Inherited[broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 InheritedDispatched before the component exits from the root 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 an object's state changes from visible to invisible.UIComponent
 InheritedDispatched when the component has finished its construction and has all initialization properties set.UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation failed.UIComponent
 InheritedDispatched when the user presses a key.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 InheritedDispatched when the user releases a key.InteractiveObject
 InheritedDispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 InheritedDispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 InheritedDispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 InheritedDispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 InheritedDispatched when the object has moved.UIComponent
 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
 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() or removeChildAt() 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
 InheritedDispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user manually scrolls the container.Container
 InheritedDispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.InteractiveObject
 InheritedDispatched when an object's state changes from invisible to visible.UIComponent
 InheritedDispatched when the value of the object's tabChildren flag changes.InteractiveObject
 InheritedDispatched when the object's tabEnabled flag changes.InteractiveObject
 InheritedDispatched when the value of the object's tabIndex property changes.InteractiveObject
 InheritedDispatched when a user enters one or more characters of text.InteractiveObject
 InheritedDispatched by the component when it is time to create a ToolTip.UIComponent
 InheritedDispatched by the component when its ToolTip has been hidden and will 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 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
Styles
 Style Description Defined By
 InheritedType: Number CSS Inheritance: no
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style.
Container
 InheritedType: String CSS Inheritance: no
If a background image is specified, this style specifies whether it is fixed with regard to the viewport ("fixed") or scrolls along with the content ("scroll").
Container
 InheritedType: uint Format: Color CSS Inheritance: no
Background color of a component.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes
Background color of the component when it is disabled.
Container
  
backgroundGradientAlphas
Type: Array CSS Inheritance: no
Specifies the alpha transparency values used for the background gradient fill of the application. You should set this to an Array of two numbers. Elements 0 and 1 specify the start and end values for an alpha gradient. The default value is [ 1.0, 1.0 ].
Application
  
backgroundGradientColors
Type: Array Format: Color CSS Inheritance: no
Specifies the colors used to tint the background gradient fill of the application. You should set this to an Array of two uint values that specify RGB colors. Elements 0 and 1 specify the start and end values for a color gradient. For a solid-color background, set the same color value for elements 0 and 1. A value of undefined means background gradient is generated based on the backgroundColor property. The default value is undefined.
Application
 InheritedType: Object Format: File CSS Inheritance: no
Background image of a component.
Container
 InheritedType: String CSS Inheritance: no
Scales the image specified by backgroundImage to different percentage sizes.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes
Determines the color of a ProgressBar.
Container
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the top edge of the content area to the control's baseline position.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: no
Color of the border.
Container
 InheritedType: String CSS Inheritance: no
Bounding box sides.
Container
 InheritedType: Class CSS Inheritance: no
The border skin class of the component.
Container
 InheritedType: String CSS Inheritance: no
Bounding box style.
Container
 InheritedType: Number Format: Length CSS Inheritance: no
Bounding box thickness.
Container
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the lower edge of the component to the lower edge of its content area.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of text in the component, including the component label.
Container
 InheritedType: Number Format: Length CSS Inheritance: no
Radius of component corners.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of text in the component if it is disabled.
Container
 InheritedType: Number CSS Inheritance: no
The alpha value for the overlay that is placed on top of the container when it is disabled.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of the drop shadow.
Container
 InheritedType: Boolean CSS Inheritance: no
Boolean property that specifies whether the component has a visible drop shadow.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
 InheritedType: String CSS Inheritance: no
Blend mode used by the focus rectangle.
UIComponent
 InheritedType: Class CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
 InheritedType: Number Format: Length CSS Inheritance: no
Thickness, in pixels, of the focus rectangle outline.
UIComponent
 InheritedType: String CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields.
Container
 InheritedType: String CSS Inheritance: yes
Name of the font to use.
Container
 InheritedType: String CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls.
Container
 InheritedType: Number CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls.
Container
 InheritedType: Number Format: Length CSS Inheritance: yes
Height of the text, in pixels.
Container
 InheritedType: String CSS Inheritance: yes
Determines whether the text is italic font.
Container
 InheritedType: Number CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls.
Container
 InheritedType: String CSS Inheritance: yes
Determines whether the text is boldface.
Container
 InheritedType: String CSS Inheritance: no
Horizontal alignment of children in the container.
LayoutContainer
 InheritedType: String CSS Inheritance: no
The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIComponent
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between children in the horizontal direction.
LayoutContainer
 InheritedType: String CSS Inheritance: no
The name of the horizontal scrollbar style.
Container
 InheritedType: Boolean CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false).
Container
 InheritedType: String CSS Inheritance: no
The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component.
UIComponent
 InheritedType: Number CSS Inheritance: yes
The number of additional pixels to appear between each character.
Container
  
modalTransparency
Type: Number CSS Inheritance: yes
Modality of components launched by the PopUp Manager is simulated by creating a large translucent overlay underneath the component. Because of the way translucent objects are rendered, you may notice a slight dimming of the objects under the overlay. The effective transparency can be set by changing the modalTransparency value from 0.0 (fully transparent) to 1.0 (fully opaque). You can also set the color of the overlay by changing the modalTransparencyColor style. The default value is 0.5.
Application
  
modalTransparencyBlur
Type: Number CSS Inheritance: yes
The blur applied to the application while a modal window is open. A Blur effect softens the details of an image. The default value is 3.

See also

Application
  
modalTransparencyColor
Type: uint Format: Color CSS Inheritance: yes
Color of the modal overlay layer. This style is used in conjunction with the modalTransparency style to determine the colorization applied to the application when a modal window is open. The default value is #DDDDDD.
Application
  
modalTransparencyDuration
Type: Number Format: Time CSS Inheritance: yes
Duration, in milliseconds, of the modal transparency effect that plays when a modal window opens or closes. The default value is 100.
Application
  
paddingBottom
Type: Number Format: Length CSS Inheritance: no
Number of pixels between the application's bottom border and its content area. The default value is 24.
Application
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the component's left border and the left edge of its content area.
Container
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the component's right border and the right edge of its content area.
Container
  
paddingTop
Type: Number Format: Length CSS Inheritance: no
Number of pixels between the application's top border and its content area. The default value is 24.
Application
 InheritedType: String CSS Inheritance: no
The horizontal distance in pixels from the right edge of the component to the right edge of its content area.
UIComponent
 InheritedType: String CSS Inheritance: no
Direction of the drop shadow.
Container
 InheritedType: Number Format: Length CSS Inheritance: no
Distance of the drop shadow.
Container
 InheritedType: String CSS Inheritance: yes
Alignment of text within a container.
Container
 InheritedType: String CSS Inheritance: yes
Determines whether the text is underlined.
Container
 InheritedType: Number Format: Length CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels.
Container
 InheritedType: uint Format: Color CSS Inheritance: yes
Theme color of a component.
UIComponent
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the top edge of the control's content area to the top edge of the component.
UIComponent
 InheritedType: String CSS Inheritance: no
Vertical alignment of children in the container.
LayoutContainer
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the center of the component's content area to the center of the component.
UIComponent
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between children in the vertical direction.
LayoutContainer
 InheritedType: String CSS Inheritance: no
The name of the vertical scrollbar style.
Container
Effects
 Effect Description Defined By
 Inherited Triggering Event: added
Played when the component is added as a child to a Container.
UIComponent
 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
 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: move
Played when the component is moved.
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
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
applicationproperty
application:Object  [read-only]

A reference to the top-level application.

In general, there can be a hierarchy of Application objects, because an Application can use a SWFLoader control to dynamically load another Application. The parentApplication property of a UIComponent can be used to access the sub-Application in which that UIComponent lives, and to walk up the hierarchy to the top-level Application.



Implementation
    public static function get application():Object
controlBarproperty 
public var controlBar:IUIComponent

The ApplicationControlBar for this Application.

The default value is null.

See also

frameRateproperty 
public var frameRate:Number

Specifies the frame rate of the application.

Note: This property cannot be set by ActionScript code; it must be set in MXML code.

The default value is 24.

historyManagementEnabledproperty 
public var historyManagementEnabled:Boolean = true

If false, the history manager will be disabled. Setting to false is recommended when using the BrowserManager.

The default value is true.

pageTitleproperty 
public var pageTitle:String

Specifies a string that appears in the title bar of the browser. This property provides the same functionality as the HTML <title> tag.

Note: This property cannot be set by ActionScript code; it must be set in MXML code.

The default value is "".

parametersproperty 
parameters:Object  [read-only]

The parameters property returns an Object containing name-value pairs representing the parameters provided to this Application.

You can use a for-in loop to extract all the names and values from the parameters Object.

There are two sources of parameters: the query string of the Application's URL, and the value of the FlashVars HTML parameter (this affects only the main Application).



Implementation
    public function get parameters():Object
preloaderproperty 
public var preloader:Object

Specifies the path of a SWC component class or ActionScript component class that defines a custom progress bar. A SWC component must be in the same directory as the MXML file or in the WEB-INF/flex/user_classes directory of your Flex web application.

Note: This property cannot be set by ActionScript code; it must be set in MXML code.

resetHistoryproperty 
public var resetHistory:Boolean = true

If true, the application's history state is reset to its initial state whenever the application is reloaded. Applications are reloaded when any of the following occurs:

The default value is true.

scriptRecursionLimitproperty 
public var scriptRecursionLimit:int

Specifies the maximum depth of Flash Player or AIR call stack before the player stops. This is essentially the stack overflow limit.

Note: This property cannot be set by ActionScript code; it must be set in MXML code.

The default value is 1000.

scriptTimeLimitproperty 
public var scriptTimeLimit:Number

Specifies the maximum duration, in seconds, that an ActionScript event handler can execute before Flash Player or AIR assumes that it is hung, and aborts it. The maximum allowable value that you can set is 60 seconds.

The default value is 60.

urlproperty 
url:String  [read-only]

The URL from which this Application's SWF file was loaded.



Implementation
    public function get url():String
usePreloaderproperty 
public var usePreloader:Boolean

If true, specifies to display the application preloader.

Note: This property cannot be set by ActionScript code; it must be set in MXML code.

The default value is true.

viewSourceURLproperty 
viewSourceURL:String

URL where the application's source can be viewed. Setting this property inserts a "View Source" menu item into the application's default context menu. Selecting the menu item opens the viewSourceURL in a new window.

You must set the viewSourceURL property using MXML, not using ActionScript, as the following example shows:

        <mx:Application viewSourceURL="http://path/to/source">
          ...
        </mx:Application>



Implementation
    public function get viewSourceURL():String
    public function set viewSourceURL(value:String):void
Constructor Detail
Application()Constructor
public function Application()

Constructor.

Method Detail
addToCreationQueue()method
public function addToCreationQueue(id:Object, preferredIndex:int = -1, callbackFunc:Function = null, parent:IFlexDisplayObject = null):void

Add a container to the Application's creation queue.

Use this mechanism to instantiate and draw the contents of a container in an ordered manner. The container should have the creationPolicy property set to "none" prior to calling this function.

Parameters

id:Object — The id of the container to add to the queue or a pointer to the container itself
 
preferredIndex:int (default = -1) — (optional) A positive integer that determines the container's position in the queue relative to the other containers presently in the queue.
 
callbackFunc:Function (default = null) — This parameter is ignored.
 
parent:IFlexDisplayObject (default = null) — This parameter is ignored.

Event Detail
applicationComplete Event
Event Object Type: mx.events.FlexEvent
property FlexEvent.type = mx.events.FlexEvent.APPLICATION_COMPLETE

Dispatched after the Application has been initialized, processed by the LayoutManager, and attached to the display list.

The FlexEvent.APPLICATION_COMPLETE constant defines the value of the type property of the event object for a applicationComplete 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.
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.
error Event  
Event Object Type: flash.events.ErrorEvent
property ErrorEvent.type = flash.events.ErrorEvent.ERROR

Dispatched when an error occurs anywhere in the application, such as an HTTPService, WebService, or RemoteObject fails.

Defines the value of the type property of an error 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 experiencing a network operation failure.
textText to be displayed as an error message.
Examples How to use this example
SimpleApplicationExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the Application container. -->

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" 
    backgroundGradientColors="[0xCCCCCC, 0x66CCFF]"
    backgroundColor="0xCCCCCC"
    horizontalAlign="center" verticalAlign="center"
    applicationComplete="appComplete();">

    <mx:Script>
        <![CDATA[
            
            // Event handlers for the components.
            private function appComplete():void {
                myTA.text+="Application creation complete" + "\n";
            }

            private function panelCreationComplete():void {
                myTA.text+="Panel creation complete" + "\n";
            }

            private function textAreaCreationComplete():void {
                myTA.text+="\n" + "TextArea creation complete" + "\n";
            }
        ]]>
    </mx:Script>

    <mx:ApplicationControlBar dock="true">
        <mx:Button label="Set Solid Fill" 
            click="this.setStyle('backgroundGradientColors', [0xCCCCCC, 0xCCCCCC]);"/>
        <mx:Button label="Set Gradient Fill" 
            click="this.setStyle('backgroundGradientColors', [0xCCCCCC, 0x66CCFF]);"/>
    </mx:ApplicationControlBar> 

    <mx:Panel title="Application Container Example" backgroundColor="0x9CB0BA"
        width="75%" height="75%" 
        creationComplete="panelCreationComplete();">
        
        <mx:TextArea id="myTA" height="100%" width="100%" 
            text="Event order: "
            creationComplete="textAreaCreationComplete();"/>

    </mx:Panel>
</mx:Application>