| Package | mx.core |
| Class | public class Application |
| Inheritance | Application  LayoutContainer Container UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Subclasses | ApolloApplication |
<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 Syntax
Hide MXML Syntax
The <mx:Application> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
Show MXML Syntax
<mx:Application
Properties
application="No default"
controlBar="null"
frameRate="24"
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"
/>
See also
| Property | Defined by | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
| DisplayObject | |
| alpha : Number
Indicates the alpha transparency value of the object specified.
| DisplayObject | |
| application : Object
[static][read-only]
A reference to the top-level application.
| Application | ||
| autoLayout : Boolean
If
true, measurement and layout are done
when the position or size of a child is changed. | Container | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality.
| UIComponent | |
| automationName : String
Name that can be used as an identifier for this object.
| UIComponent | |
| automationTabularData : Object
An implementation of the
IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array
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 | |
| baselinePosition : Number
The vertical distance (in pixels) between the top of the
container and the baseline of the first line of text.
| Container | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use.
| DisplayObject | |
| borderMetrics : EdgeMetrics
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | Container | |
| buttonMode : Boolean
Specifies the button mode of this sprite.
| Sprite | |
| cacheAsBitmap : Boolean
If set to
true, Flash Player caches an internal bitmap representation of the
display object. | DisplayObject | |
| cacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
| UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | |
| childDescriptors : Array
Array of UIComponentDescriptor objects produced by the MXML compiler.
| Container | |
| className : String
The name of this instance's class, such as
"Button". | UIComponent | |
| clipContent : Boolean
Whether to apply a clip mask if the positions and/or sizes
of this container's children extend outside the borders of
this container.
| Container | |
| constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| contentMouseX : Number
Returns the x position of the mouse, in the content coordinate system.
| Container | |
| contentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
| Container | |
| contextMenu : ContextMenu
Specifies the context menu associated with this object.
| InteractiveObject | |
| controlBar : IUIComponent
The ApplicationControlBar for this Application.
| Application | ||
| creationIndex : int
Specifies the order to instantiate and draw the children
of the container.
| Container | |
| creationPolicy : String
The child creation policy for this Container.
| Container | |
| currentState : String
The current view state of the component.
| UIComponent | |
| data : Object
The
data property lets you pass a value
to the component when you use it in an item renderer or item editor. | Container | |
| defaultButton : IFlexDisplayObject
The Button control designated as the default button
for the container.
| Container | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the
createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | |
| doubleClickEnabled : Boolean
Specifies whether the UIComponent object receives
doubleClick events. | UIComponent | |
| dropTarget : DisplayObject
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped.
| Sprite | |
| enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | |
| errorString : 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 | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object.
| DisplayObject | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when clicked on.
| UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers.
| UIComponent | |
| focusPane : Sprite
The focus pane associated with this object.
| UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle.
| InteractiveObject | |
| frameRate : Number
Specifies the frame rate of the application.
| Application | ||
| graphics : Graphics
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur.
| Sprite | |
| height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
| Sprite | |
| horizontalLineScrollSize : Number
Number of pixels to move when the left- or right-arrow
button in the horizontal scroll bar is pressed.
| Container | |
| horizontalPageScrollSize : Number
Number of pixels to move when the track in the
horizontal scroll bar is pressed.
| Container | |
| horizontalScrollBar : ScrollBar
The horizontal scrollbar used in this container.
| Container | |
| horizontalScrollPolicy : String
Specifies whether the horizontal scroll bar is always present,
always absent, or automatically added when needed.
| Container | |
| horizontalScrollPosition : Number
The current position of the horizontal scroll bar.
| Container | |
| id : String
ID of the component.
| UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles.
| UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required).
| UIComponent | |
| instanceIndex : int
The index of a repeated component.
| UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document.
| UIComponent | |
| isDocument : Boolean
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 | |
| isPopUp : Boolean
Set to
true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| layout : String
Specifies the layout mechanism used for this application.
| LayoutContainer | |
| loaderInfo : LoaderInfo
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs.
| DisplayObject | |
| mask : DisplayObject
The calling display object is masked by the specified
mask object. | DisplayObject | |
| maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| maxHorizontalScrollPosition : Number
The largest possible value for the
horizontalScrollPosition property. | Container | |
| maxVerticalScrollPosition : Number
The largest possible value for the
verticalScrollPosition property. | Container | |
| maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | |
| minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| moduleFactory : IFlexModuleFactory | UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
| DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse messages.
| InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | |
| mouseX : Number
Indicates the x coordinate of the mouse position, in pixels.
| DisplayObject | |
| mouseY : Number
Indicates the y coordinate of the mouse position, in pixels.
| DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject.
| DisplayObject | |
| nestLevel : int
Depth of this object in the containment hierarchy.
| UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
| UIComponent | |
| numAutomationChildren : int
The number of automation children this container has.
| UIComponent | |
| numChildren : int
Number of child components in this container.
| Container | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
| DisplayObject | |
| owner : 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 | ||
| parent : DisplayObjectContainer
The parent container or component for this component.
| UIComponent | |
| parentApplication : Object
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | |
| parentDocument : Object
A reference to the parent document object for this UIComponent.
| UIComponent | |
| percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | |
| percentWidth : 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 | ||
| processedDescriptors : Boolean
Set to
true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| rawChildren : IChildList
A container typically contains child components, which can be enumerated
using the
Container.getChildAt() method and
Container.numChildren property. | Container | |
| repeater : IRepeater
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | |
| repeaterIndex : int
The index of the item in the data provider
of the Repeater that produced this UIComponent.
| UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
| UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
| UIComponent | |
| resetHistory : Boolean = true
If
true, the application's history state is reset
to its initial state whenever the application is reloaded. | Application | ||
| root : DisplayObject
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 | |
| rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
| DisplayObject | |
| scale9Grid : Rectangle
The current scaling grid that is in effect.
| DisplayObject | |
| scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | |
| scaleY : Number
Number that specifies the vertical scaling percentage.
| UIComponent | |
| screen : Rectangle
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 the Adobe Flash Player
call stack before Flash Player stops.
| Application | ||
| scriptTimeLimit : Number
Specifies the maximum duration, in seconds, that an ActionScript
event handler can execute before the Flash Player assumes
that it is hung, and aborts it.
| Application | ||
| scrollRect : Rectangle
The scroll rectangle bounds of the display object.
| DisplayObject | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | |
| soundTransform : SoundTransform
Controls sound within this sprite.
| Sprite | |
| stage : Stage
The Stage of the display object.
| DisplayObject | |
| states : Array
The view states that are defined for this component.
| UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | |
| styleName : Object
The class style used by this component.
| UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled.
| DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order.
| InteractiveObject | |
| textSnapshot : TextSnapshot
Returns a TextSnapshot object for this DisplayObjectContainer instance.
| DisplayObjectContainer | |
| transform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
| DisplayObject | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs.
| UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UIComponent | |
| uid : String
A unique identifier for the object.
| UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required).
| UIComponent | |
| url : String
[read-only]
The URL from which this Application's SWF file was loaded.
| Application | ||
| useHandCursor : 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 | ||
| validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | |
| verticalLineScrollSize : Number
Number of pixels to scroll when the up- or down-arrow
button in the vertical scroll bar is pressed.
| Container | |
| verticalPageScrollSize : Number
Number of pixels to scroll when the track
in the vertical scroll bar is pressed.
| Container | |
| verticalScrollBar : ScrollBar
The vertical scrollbar used in this container.
| Container | |
| verticalScrollPolicy : String
Specifies whether the vertical scroll bar is always present,
always absent, or automatically added when needed.
| Container | |
| verticalScrollPosition : Number
The current position of the vertical scroll bar.
| Container | |
| viewMetrics : EdgeMetrics
Returns an object that has four properties:
left,
top, right, and bottom. | Container | |
| viewMetricsAndPadding : EdgeMetrics
Returns an object that has four properties:
left,
top, right, and bottom. | Container | |
| viewSourceURL : String
URL where the application's source can be viewed.
| Application | ||
| visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | |
| width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| Application | ||
|
Adds a child DisplayObject to this Container.
| Container | |
|
Adds a child DisplayObject to this Container.
| Container | |
|
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 | ||
|
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 | |
|
Queues a function to be called later.
| UIComponent | |
|
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
| UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself.
| DisplayObjectContainer | |
|
Converts a
Point object from content coordinates to global coordinates. | Container | |
|
Converts a
Point object from content to local coordinates. | Container | |
|
Returns a set of properties that identify the child within
this container.
| UIComponent | |
|
Given a single UIComponentDescriptor, create the corresponding
component and add the component as a child of this Container.
| Container | |
|
createComponentsFromDescriptors(recurse:Boolean = true):void
Iterate through the Array of
childDescriptors,
and call the createComponentFromDescriptor() method for each one. | Container | |
|
createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an
id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the
id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent.
| UIComponent | |
| UIComponent | ||
|
Shows or hides the focus indicator around this component.
| UIComponent | |
|
drawRoundRect(x:Number, y:Number, width:Number, height:Number, cornerRadius:Object = null, color:Object = null, alpha:Object = null, gradientMatrix:Matrix = null, gradientType:String = "linear", gradientRatios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
| UIComponent | |
|
effectFinished(effectInst:EffectInstance):void
Called by the effect instance when it stops playing on the component.
| UIComponent | |
|
effectStarted(effectInst:EffectInstance):void
Called by the effect instance when it starts playing on the component.
| UIComponent | |
|
endEffectsStarted():void
Ends all currently playing effects on the component.
| UIComponent | |
|
executeBindings(recurse:Boolean = false):void
Executes all the data bindings on this Container.
| Container | |
|
executeChildBindings(recurse:Boolean):void
Executes the bindings into this Container's child UIComponent objects.
| Container | |
|
Called after printing is complete.
| UIComponent | |
|
Provides the automation object at the specified index.
| UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the
targetCoordinateSpace object. | DisplayObject | |
|
Gets the nth child component object.
| Container | |
|
Returns the child whose
name property is the specified String. | Container | |
|
Gets the zero-based index of a specific child.
| Container | |
|
Returns an Array of DisplayObject objects consisting of the content children
of the container.
| Container | |
|
Finds the type selectors for this UIComponent instance.
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |