| Package | mx.core |
| Class | public class Application |
| Inheritance | Application  LayoutContainer Container UIComponent FlexSprite flash.display.Sprite |
<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"
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"
/>
See also
| Property | Defined by | ||
|---|---|---|---|
 | activeEffects : Array
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
| UIComponent | |
| 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 y-coordinate of the baseline
of the first line of text of the component.
| UIComponent | |
| borderMetrics : EdgeMetrics
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | Container | |
| 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 | |
| constraintColumns : Array
An Array of ConstraintColumn instances that partition this container.
| LayoutContainer | |
| constraintRows : Array
An Array of ConstraintRow instances that partition this container.
| LayoutContainer | |
| contentMouseX : Number
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 | |
| controlBar : IUIComponent
The ApplicationControlBar for this Application.
| Application | ||
| creatingContentPane : Boolean
Containers use an internal content pane to control scrolling.
| Container | |
| 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 | |
| cursorManager : ICursorManager
Gets the CursorManager that controls the cursor for this component
and its peers.
| UIComponent | |
| data : Object
The
data property lets you pass a value
to the component when you use it in an item renderer or item editor. | Container | |
| defaultButton : IFlexDisplayObject
The Button control designated as the default button
for the container.
| Container | |
| 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 | |
| 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
The maximum recommended height of the component to be considered
by the parent during layout.
| UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout.
| UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout.
| UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout.
| UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
| UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
| UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers.
| UIComponent | |
| focusPane : Sprite
The focus pane associated with this object.
| UIComponent | |
| frameRate : Number
Specifies the frame rate of the application.
| Application | ||
| height : Number
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 | ||
| 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 | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout.
| 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
The maximum recommended width of the component to be considered
by the parent during layout.
| UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout.
| UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout.
| UIComponent | |
| moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UIComponent | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | |
| 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 | |
| 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 | |
| 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 | ||
| scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | |
| scaleY : Number
Number that specifies the vertical scaling factor.
| 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 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 | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | |
| 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 | |
| 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 | ||
| 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,
or when you scroll by using the mouse wheel.
| Container | |
| verticalPageScrollSize : Number
Number of pixels to scroll when the track
in the vertical scroll bar is pressed.
| Container | |
| verticalScrollBar : ScrollBar
The vertical scrollbar used in this container.
| Container | |
| verticalScrollPolicy : String
Specifies whether the vertical scroll bar is always present,
always absent, or automatically added when needed.
| Container | |
| verticalScrollPosition : Number
The current position of the vertical scroll bar.
| Container | |
| viewMetrics : EdgeMetrics
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 | ||
|
addChild(child:DisplayObject):DisplayObject
Adds a child DisplayObject to this Container.
| Container | |
|
addChildAt(child:DisplayObject, index:int):DisplayObject
Adds a child DisplayObject to this Container.
| Container | |
|
addToCreationQueue(id:Object, preferredIndex:int = -1, callbackFunc:Function = null, parent:IFlexDisplayObject = null):void
Add a container to the Application's creation queue.
| Application | ||
|
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
| UIComponent | |
|
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
| UIComponent | |
|
contentToGlobal(point:Point):Point
Converts a
Point object from content coordinates to global coordinates. | Container | |
|
contentToLocal(point:Point):Point
Converts a
Point object from content to local coordinates. | Container | |
|
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container.
| UIComponent | |
|
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 | |
|
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
| UIComponent | |
|
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
| UIComponent | |
|
drawRoundRect(x:Number, y:Number, 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:IEffectInstance):void
Called by the effect instance when it stops playing on the component.
| UIComponent | |
|
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
| UIComponent | |
|
endEffectsStarted():void
Ends all currently playing effects on the component.
| UIComponent | |
|
executeBindings(recurse:Boolean = false):void
Executes all the data bindings on this Container.
| Container | |
|
executeChildBindings(recurse:Boolean):void
Executes the bindings into this Container's child UIComponent objects.
| Container | |
|
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
| UIComponent | |
|
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index.
| UIComponent | |
|
getChildAt(index:int):DisplayObject
Gets the nth child component object.
| Container | |
|
getChildByName(name:String):DisplayObject
Returns the child whose
name property is the specified String. | Container | |
|
getChildIndex(child:DisplayObject):int
Gets the zero-based index of a specific child.
| Container | |
|
getChildren():Array
Returns an Array of DisplayObject objects consisting of the content children
of the container.
| Container | |
|
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance.
| UIComponent | |
|
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component.
| UIComponent | |
|
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
getFocus():InteractiveObject
Gets the object that currently has focus.
| UIComponent | |
|
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the
dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UIComponent | |
|
globalToContent(point:Point):Point
Converts a
Point object from global to content coordinates. | Container | |
|
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
initialize():void
Initializes the internal structure of this component.
| UIComponent | |
|
initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component.
| UIComponent | |
|
invalidateDisplayList():void
Marks a component so that its
updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
invalidateProperties():void
Marks a component so that its
commitProperties()
method gets called during a later screen update. | UIComponent | |
|
invalidateSize():void
Marks a component so that its
measure()
method gets called during a later screen update. | UIComponent | |
|
localToContent(point:Point):Point
Converts a
Point object from local to content coordinates. | Container | |
|
measureHTMLText(htmlText:String):TextLineMetrics
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 | |
|
measureText(text:String):TextLineMetrics
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 | |
|
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
| UIComponent | |
|
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
| UIComponent | |
|
owns(child:DisplayObject):Boolean
Returns
true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
| UIComponent | |
|
prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing.
| UIComponent | |
|
regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component
and, if the
recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners.
| UIComponent | |
|
removeAllChildren():void
Removes all children from the child list of this container.
| Container | |
|
removeChild(child:DisplayObject):DisplayObject
Removes a child DisplayObject from the child list of this Container.
| Container | |
|
removeChildAt(index:int):DisplayObject
Removes a child DisplayObject from the child list of this Container
at the specified index.
| Container | |
|
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
| UIComponent | |
|
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
| UIComponent | |
|
resumeBackgroundProcessing():void
[static]
Resumes the background processing of methods
queued by
callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
setActualSize(w:Number, h:Number):void
Sizes the object.
| UIComponent | |
|
setChildIndex(child:DisplayObject, newIndex:int):void
Sets the index of a particular child.
| Container | |
|
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component.
| UIComponent | |
|
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
| UIComponent | |
|
setFocus():void
Sets the focus to this component.
| UIComponent | |
|
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
| UIComponent | |
|
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the
visible property changes. | UIComponent | |
|
styleChanged(styleProp:String):void
Detects changes to style properties.
| UIComponent | |
|
stylesInitialized():void
Flex calls the
stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
|
suspendBackgroundProcessing():void
[static]
Blocks the background processing of methods
queued by
callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
toString():String
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | |
|
validateDisplayList():void
Validates the position and size of children and draws other
visuals.
| UIComponent | |
|
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UIComponent | |
|
validateProperties():void
Used by layout logic to validate the properties of a component
by calling the
commitProperties() method. | UIComponent | |
|
validateSize(recursive:Boolean = false):void
Validates the measured size of the component
If the
LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
validationResultHandler(event:ValidationResultEvent):void
Handles both the
valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to
drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
|
Dispatched when the component is added to a container as a content child
by using the addChild() or addChildAt() method. | UIComponent | ||
| Dispatched after the Application has been initialized, processed by the LayoutManager, and attached to the display list. | Application | |||
| Dispatched after a child has been added to a container. | Container | ||
| Dispatched after the index (among the container children) of a container child changes. | Container | ||
| Dispatched before a child of a container is removed. | Container | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
|
Dispatched after the currentState property changes,
but before the view state changes. | UIComponent | ||
|
Dispatched when the data property changes. | Container | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched 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 | |||
| Dispatched before the component exits from the root view state. | UIComponent | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
|
Dispatched when the component is removed from a container as a content child
by using the removeChild() or removeChildAt() method. | UIComponent | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when the user manually scrolls the container. | Container | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and will be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
|
Dispatched by a component whose toolTip property is set,
as soon as the user moves the mouse over it. | UIComponent | ||
|
Dispatched when an object has had its commitProperties(),
measure(), and
updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
| Style | Description | Defined by | ||
|---|---|---|---|---|
| Type: 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 | ||
| Type: String CSS Inheritance: no If a background image is specified, this style specifies whether it is fixed with regard to the viewport ( "fixed")
or scrolls along with the content ("scroll"). | Container | ||
| Type: uint Format: Color CSS Inheritance: no Background color of a component. | Container | ||
| Type: 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 | ||
| Type: Object Format: File CSS Inheritance: no Background image of a component. | Container | ||
| Type: String CSS Inheritance: no Scales the image specified by backgroundImage
to different percentage sizes. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Determines the color of a ProgressBar. | Container | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: no Color of the border. | Container | ||
| Type: String CSS Inheritance: no Bounding box sides. | Container | ||
| Type: Class CSS Inheritance: no The border skin class of the component. | Container | ||
| Type: String CSS Inheritance: no Bounding box style. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Bounding box thickness. | Container | ||
| Type: 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 | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Radius of component corners. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | Container | ||
| Type: Number CSS Inheritance: no The alpha value for the overlay that is placed on top of the container when it is disabled. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the drop shadow. | Container | ||
| Type: Boolean CSS Inheritance: no Boolean property that specifies whether the component has a visible drop shadow. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. | Container | ||
| Type: String CSS Inheritance: yes Name of the font to use. | Container | ||
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls. | Container | ||
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls. | Container | ||
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | Container | ||
| Type: String CSS Inheritance: yes Determines whether the text is italic font. | Container | ||
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls. | Container | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. | Container | ||
| Type: String CSS Inheritance: no Horizontal alignment of children in the container. | LayoutContainer | ||
| Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the horizontal direction. | LayoutContainer | ||
| Type: String CSS Inheritance: no The name of the horizontal scrollbar style. | Container | ||
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | Container | ||
| Type: 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 | ||
| Type: 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. | 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 | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. | Container | ||
|
paddingTop
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the application's top border and its content area. The default value is 24. | Application | ||
| Type: 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 | ||
| Type: String CSS Inheritance: no Direction of the drop shadow. | Container | ||
| Type: Number Format: Length CSS Inheritance: no Distance of the drop shadow. | Container | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. | Container | ||
| Type: String CSS Inheritance: yes Determines whether the text is underlined. | Container | ||
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | Container | ||
| Type: uint Format: Color CSS Inheritance: yes Theme color of a component. | UIComponent | ||
| Type: 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 | ||
| Type: String CSS Inheritance: no Vertical alignment of children in the container. | LayoutContainer | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the vertical direction. | LayoutContainer | ||
| Type: String CSS Inheritance: no The name of the vertical scrollbar style. | Container | ||
| application | property |
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.
public static function get application():Object
| controlBar | property |
public var controlBar:IUIComponentThe ApplicationControlBar for this Application.
The default value is null.
See also
| frameRate | property |
public var frameRate:NumberSpecifies 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.
| historyManagementEnabled | property |
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.
| pageTitle | property |
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 "".
| parameters | property |
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
| preloader | property |
public var preloader:ObjectSpecifies 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.
| resetHistory | property |
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.
| scriptRecursionLimit | property |
public var scriptRecursionLimit:intSpecifies 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.
| scriptTimeLimit | property |
public var scriptTimeLimit:NumberSpecifies 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.
| url | property |
url:String [read-only]The URL from which this Application's SWF file was loaded.
Implementation public function get url():String
| usePreloader | property |
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.
| viewSourceURL | property |
viewSourceURL:String [read-write]
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
| Application | () | constructor |
public function Application()Constructor.
| addToCreationQueue | () | method |
public function addToCreationQueue(id:Object, preferredIndex:int = -1, callbackFunc:Function = null, parent:IFlexDisplayObject = null):voidAdd 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.
id:Object — The id of the container to add to the queue or a
pointer to the container itself
|
|
preferredIndex:int (default = -1) |
|
callbackFunc:Function (default = null) |
|
parent:IFlexDisplayObject (default = null) |
| applicationComplete | event |
mx.events.FlexEvent
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
| error | event |
flash.events.ErrorEvent
Dispatched when an error occurs anywhere in the application, such as an HTTPService, WebService, or RemoteObject fails.