Package | spark.components |
Class | public class Application |
Inheritance | Application SkinnableContainer SkinnableContainerBase SkinnableComponent UIComponent FlexSprite flash.display.Sprite |
Subclasses | ViewNavigatorApplicationBase, WindowedApplication |
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The Application container has the following default characteristics:
Characteristic | Description |
---|---|
Default size | 375 pixels high and 500 pixels wide in the Standalone Flash Player, and all available space in a browser |
Minimum size | 0 pixels wide and 0 pixels high |
Maximum size | No limit |
Default skin class | spark.skins.spark.ApplicationSkin |
The <s:Application>
tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
<s:Application Properties applicationDPI=Device dependent" backgroundColor="0xFFFFFF" colorCorrection="default" controlBarContent="null" controlBarLayout="HorizontalLayout" controlBarVisible="true" frameRate="24" pageTitle"" preloader="No default" preloaderChromeColor="No default" resizeForSoftKeyboard=true" runtimeDPIProvider="RuntimeDPIProvider" scriptRecursionLimit="1000" scriptTimeLimit="60" splashScreenImage="" splashScreenMinimumDisplayTime="1000" splashScreenScaleMode="none" usePreloader="true" viewSourceURL="" xmlns:No default="No default" Events applicationComplete="No default" error="No default" />
Default MXML PropertymxmlContentFactory
See also
Property | Defined By | ||
---|---|---|---|
accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | ||
applicationDPI : Number
The DPI of the application. | Application | ||
aspectRatio : String [read-only]
Returns the aspect ratio of the top level stage based on its width
and height. | Application | ||
autoLayout : Boolean
If true, measurement and layout are done
when the position or size of a child is changed. | SkinnableContainer | ||
automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | ||
automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | ||
automationName : String
Name that can be used as an identifier for this object. | UIComponent | ||
automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | ||
automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | ||
automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | ||
automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | ||
automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | ||
baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
baselinePosition : Number [override] [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | SkinnableComponent | ||
bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | ||
cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | ||
className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | ||
colorCorrection : String
The value of the stage's colorCorrection property. | Application | ||
contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | ||
contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | ||
controlBarContent : Array
The set of components to include in the control bar area of the
Application container. | Application | ||
controlBarLayout : LayoutBase
Defines the layout of the control bar area of the container. | Application | ||
controlBarVisible : Boolean
If true, the control bar is visible. | Application | ||
creationPolicy : String
Content creation policy for this component. | SkinnableContainer | ||
currentState : String
The current view state of the component. | UIComponent | ||
cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | ||
defaultButton : IFlexDisplayObject
The Button control designated as the default button for the container. | SkinnableContainerBase | ||
deferredContentCreated : Boolean [read-only]
Contains true if deferred content has been created. | SkinnableContainer | ||
depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | ||
descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | ||
designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | ||
document : Object
A reference to the document object associated with this UIComponent. | UIComponent | ||
doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | ||
enabled : Boolean
Whether the component can accept user interaction. | UIComponent | ||
errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | ||
explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | ||
explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | ||
explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | ||
explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | ||
explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | ||
explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | ||
flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | ||
focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | ||
focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | ||
focusPane : Sprite
The focus pane associated with this object. | UIComponent | ||
frameRate : Number
Specifies the frame rate of the application. | Application | ||
hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | ||
hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | ||
height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | ||
horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
id : String
ID of the component. | UIComponent | ||
includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | ||
inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | ||
initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | ||
instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | ||
instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | ||
is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | ||
isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | ||
isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | ||
layout : LayoutBase
The layout object for this container. | SkinnableContainer | ||
layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | ||
left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | ||
maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | ||
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
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | ||
mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | ||
mxmlContent : Array [write-only]
The visual content children for this Group. | SkinnableContainer | ||
mxmlContentFactory : IDeferredInstance [write-only]
A factory object that creates the initial value for the
content property. | SkinnableContainer | ||
MXMLDescriptor : Array [read-only] | UIComponent | ||
MXMLProperties : Array [read-only] | 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 [read-only]
The number of automation children this container has. | UIComponent | ||
numElements : int [read-only]
The number of visual elements in this container. | SkinnableContainer | ||
owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | ||
pageTitle : String
Specifies a string that appears in the title bar of the browser. | Application | ||
parameters : Object [read-only]
An Object containing name-value
pairs representing the parameters provided to this Application. | Application | ||
parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | ||
parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | ||
parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | ||
percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | ||
percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | ||
postLayoutTransformOffsets : TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | ||
preloader : Object
The application container supports an application preloader that
uses a download progress bar to show the download and initialization progress
of an application SWF file. | Application | ||
preloaderChromeColor : uint
Specifies the chrome color used by the default preloader component. | Application | ||
processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | ||
repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | ||
repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | ||
repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | ||
repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | ||
resizeForSoftKeyboard : Boolean
Some devices do not support a hardware keyboard. | Application | ||
right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
rotation : Number [override] | UIComponent | ||
rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | ||
rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | ||
rotationZ : Number [override]
| UIComponent | ||
runtimeDPI : Number [read-only]
The DPI of the device the application is currently running on. | Application | ||
runtimeDPIProvider : Class
A class that extends RuntimeDPIProvider and overrides the default Flex
calculations for runtimeDPI. | Application | ||
scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | ||
scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | ||
scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | ||
screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | ||
scriptRecursionLimit : int
Specifies the maximum depth of Flash Player or AIR
call stack before the player stops. | Application | ||
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 | ||
skin : UIComponent [read-only]
The instance of the skin class for this component instance. | SkinnableComponent | ||
splashScreenImage : Class
The image class for the SplashScreen preloader. | Application | ||
splashScreenMinimumDisplayTime : Number
Minimum amount of time, in milliseconds, to show the splash screen image. | Application | ||
splashScreenScaleMode : String
The splash screen image scale mode:
A value of none implies that the image size is set
to match its intrinsic size.
A value of stretch sets the width and the height of the image to the
stage width and height, possibly changing the content aspect ratio.
A value of letterbox sets the width and height of the image
as close to the stage width and height as possible while maintaining aspect ratio. | Application | ||
states : Array
The view states that are defined for this component. | UIComponent | ||
styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | ||
styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | ||
styleName : Object
The class style used by this component. | UIComponent | ||
styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | ||
suggestedFocusSkinExclusions : Array [read-only]
Lists the skin parts that are
excluded from bitmaps captured and used to
show focus. | SkinnableComponent | ||
systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | ||
tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | ||
top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
transform : Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | ||
transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | ||
transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | ||
transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | ||
transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | ||
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 | ||
verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
viewSourceURL : String
URL where the application's source can be viewed. | Application | ||
visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | ||
width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | ||
z : Number [override]
| UIComponent |
Method | Defined By | ||
---|---|---|---|
Constructor. | Application | ||
Adds a visual element to this container. | SkinnableContainer | ||
Adds a visual element to this container. | SkinnableContainer | ||
addStyleClient(styleClient:IAdvancedStyleClient):void
Adds a non-visual style client to this component instance. | UIComponent | ||
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. | UIComponent | ||
contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates. | UIComponent | ||
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container. | UIComponent | ||
createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Returns a set of properties as automation IDs that identify the child within
this container. | UIComponent | ||
createDeferredContent():void
Create the content for this component. | SkinnableContainer | ||
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 [override]
Dispatches an event into the event flow. | UIComponent | ||
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component. | UIComponent | ||
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | ||
effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component. | UIComponent | ||
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component. | UIComponent | ||
endEffectsStarted():void
Ends all currently playing effects on the component. | UIComponent | ||
executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | ||
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete. | UIComponent | ||
generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent | ||
generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent | ||
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index. | UIComponent | ||
getAutomationChildren():Array
Provides the automation object list . | UIComponent | ||
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | ||
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | ||
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance. | UIComponent | ||
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | ||
getElementAt(index:int):IVisualElement
Returns the visual element at the specified index. | SkinnableContainer | ||
getElementIndex(element:IVisualElement):int
Returns the index position of a visual element. | SkinnableContainer | ||
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | ||
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | ||
getFocus():InteractiveObject
Gets the object that currently has focus. | UIComponent | ||
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height. | UIComponent | ||
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width. | UIComponent | ||
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen. | UIComponent | ||
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen. | UIComponent | ||
getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | ||
getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element. | UIComponent | ||
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height. | UIComponent | ||
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width. | UIComponent | ||
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height. | UIComponent | ||
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width. | UIComponent | ||
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height. | UIComponent | ||
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width. | UIComponent | ||
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | ||
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | ||
getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user
on the screen. | UIComponent | ||
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates. | UIComponent | ||
hasCSSState():Boolean
Returns true if currentCSSState is not null. | UIComponent | ||
hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | ||
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | ||
initialize():void
Initializes the internal structure of this component. | UIComponent | ||
initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | ||
invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | ||
invalidateLayering():void
Called by a component's items to indicate that their depth
property has changed. | UIComponent | ||
invalidateLayoutDirection():void
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | ||
invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | ||
invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | ||
invalidateSkinState():void
Marks the component so that the new state of the skin is set
during a later screen update. | SkinnableComponent | ||
localToContent(point:Point):Point
Converts a Point object from local to content coordinates. | UIComponent | ||
matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState. | UIComponent | ||
matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | ||
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | ||
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | ||
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 | ||
removeAllElements():void
Removes all visual elements from the container. | SkinnableContainer | ||
Removes the specified visual element from the child list of
this container. | SkinnableContainer | ||
removeElementAt(index:int):IVisualElement
Removes a visual element from the specified index position
in the container. | SkinnableContainer | ||
removeStyleClient(styleClient:IAdvancedStyleClient):void
Removes a non-visual style client from this component instance. | UIComponent | ||
replayAutomatableEvent(event:Event):Boolean
Replays the specified event. | UIComponent | ||
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. | UIComponent | ||
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 | ||
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | ||
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state. | UIComponent | ||
setElementIndex(element:IVisualElement, index:int):void
Changes the position of an existing visual element in the visual container. | SkinnableContainer | ||
setFocus():void
Sets the focus to this component. | UIComponent | ||
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | UIComponent | ||
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element. | UIComponent | ||
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | ||
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | ||
setMXMLDescriptor(value:Array):void | UIComponent | ||
setMXMLProperties(value:Array):void | UIComponent | ||
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance. | UIComponent | ||
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes. | UIComponent | ||
styleChanged(styleProp:String):void
Detects changes to style properties. | UIComponent | ||
stylesInitialized():void
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | ||
suspendBackgroundProcessing():void [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | ||
Swaps the index of the two specified visual elements. | SkinnableContainer | ||
swapElementsAt(index1:int, index2:int):void
Swaps the visual elements at the two specified index
positions in the container. | SkinnableContainer | ||
toString():String [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | ||
transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | ||
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | ||
validateDisplayList():void
Validates the position and size of children and draws other
visuals. | UIComponent | ||
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | ||
validateProperties():void
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | ||
validateSize(recursive:Boolean = false):void
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | ||
validationResultHandler(event:ValidationResultEvent):void
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | ||
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | |||
Dispatched after the Application has been initialized, processed by the LayoutManager, and attached to the display list. | Application | |||
Dispatched after the content for this component has been created. | SkinnableContainer | |||
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 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 an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | |||
Dispatched when a visual element is added to the content holder. | SkinnableContainer | |||
Dispatched when a visual element is removed from the content holder. | SkinnableContainer | |||
Dispatched after the component has entered a view state. | UIComponent | |||
Dispatched when an HTTPService call fails. | Application | |||
Dispatched just before the component exits a 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(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | |||
Dispatched when the component is resized. | UIComponent | |||
Dispatched when an object's state changes from invisible to visible. | UIComponent | |||
Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | |||
Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | 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 is to 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 | |||
A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | |||
A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | |||
A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | |||
Dispatched when an uncaught error is caught by the Global Exception Handler | Application | |||
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: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Accent color used by component skins. | SkinnableContainer | |||
Type: String CSS Inheritance: yes Specifies the baseline to which the dominant baseline aligns. See also | SkinnableContainer | |||
Type: Array Format: Color CSS Inheritance: yes Theme: spark, mobile The colors to use for the backgrounds of the items in the list. | SkinnableContainer | |||
Type: Number CSS Inheritance: no Theme: spark, mobile Alpha level of the background for this component. | SkinnableContainer | |||
backgroundColor | Type: uint Format: Color CSS Inheritance: no The background color of the application. This color is used as the stage color for the application and the background color for the HTML embed tag. The default value is 0x464646 . | Application | ||
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: Object CSS Inheritance: yes Amount to shift the baseline. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Specifies a vertical or horizontal progression of line placement. See also | SkinnableContainer | |||
Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | |||
Type: String CSS Inheritance: yes Controls where lines are allowed to break when breaking wrapping text into multiple lines. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes The type of CFF hinting used for this text. See also | SkinnableContainer | |||
Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The main color for a component. | SkinnableComponent | |||
Type: String CSS Inheritance: yes Controls how text wraps around a float. See also | SkinnableContainer | |||
Type: uint Format: Color CSS Inheritance: yes Color of the text. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Controls column break after the element. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Controls column break before the element. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Controls container break after the element. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Controls container break before the element. See also | SkinnableContainer | |||
Type: Number CSS Inheritance: yes Theme: spark, mobile The alpha of the content background for this component. | SkinnableContainer | |||
Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The color of the content background for this component. | SkinnableContainer | |||
Type: String CSS Inheritance: yes The type of digit case used for this text. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Type of digit width used for this text. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Specifies the default bidirectional embedding level of the text. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line.See also | SkinnableContainer | |||
Type: uint Format: Color CSS Inheritance: yes Theme: mobile Color of the background of an item renderer when it is being pressed down If The default value for the Spark theme is | SkinnableContainer | |||
Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | |||
Type: Class Name of the skin class to use for this component when a validation error occurs. | SkinnableComponent | |||
Type: Object CSS Inheritance: yes Specifies the baseline position of the first line in the container. See also | SkinnableContainer | |||
Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of focus ring when the component is in focus. | SkinnableContainer | |||
Type: uint Format: Color CSS Inheritance: yes The color of text when the component is enabled and has focus. | SkinnableContainer | |||
Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | |||
Type: String CSS Inheritance: yes The name of the font to use, or a comma-separated list of font names. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Font lookup to use. See also | SkinnableContainer | |||
Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Determines whether the text is italic font. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Determines whether the text is boldface. See also | SkinnableContainer | |||
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: uint Format: Color CSS Inheritance: yes The color of text when the component is disabled. | SkinnableContainer | |||
Type: String CSS Inheritance: yes The primary interaction mode for this component. See also | UIComponent | |||
Type: String CSS Inheritance: yes Rule used to justify text in a paragraph. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes The style used for justification of the paragraph. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes The style used for justification of the paragraph. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also | UIComponent | |||
Type: Number Format: Length CSS Inheritance: yes Theme: mobile Additional vertical space between lines of text. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Specifies the leading model, which is a combination of leading basis and leading direction. See also | SkinnableContainer | |||
Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | |||
Type: Number CSS Inheritance: yes Theme: mobile The number of additional pixels to appear between each character. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Controls which of the ligatures that are defined in the font may be used in the text. See also | SkinnableContainer | |||
Type: Object CSS Inheritance: yes Leading controls for the text. See also | SkinnableContainer | |||
Type: Boolean CSS Inheritance: yes If true, applies strikethrough, a line drawn through the middle of the text. See also | SkinnableContainer | |||
Type: Number Format: length CSS Inheritance: yes This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto .See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes This controls the placement of a list item marker relative to the list item. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes This controls the appearance of items in a list. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes The locale of the text. See also | SkinnableContainer | |||
osStatusBarHeight | Type: Number Format: Length CSS Inheritance: no Theme: mobile Height in pixels left for os top status bar display. Status bar height is set by default to 20 pixels (at 160 DPI) for iOS7, on the following default skins:
| Application | ||
Type: Number Format: length CSS Inheritance: yes The amount to indent the paragraph's end edge. See also | SkinnableContainer | |||
Type: Number Format: length CSS Inheritance: yes The amount of space to leave after the paragraph. See also | SkinnableContainer | |||
Type: Number Format: length CSS Inheritance: yes The amount of space to leave before the paragraph. See also | SkinnableContainer | |||
Type: Number Format: length CSS Inheritance: yes The amount to indent the paragraph's start edge. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes The rendering mode used for this text which applies only to embedded fonts. See also | SkinnableContainer | |||
Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | |||
Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the highlights when the mouse is over the component. | SkinnableContainer | |||
Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent | |||
Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent | |||
Type: Class Name of the skin class to use for this component. | SkinnableComponent | |||
Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile Color of any symbol of a component. | SkinnableContainer | |||
Type: String CSS Inheritance: yes Specifies the tab stops associated with the paragraph. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Alignment of text within a container. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Alignment of the last line in the paragraph relative to the container in justified text. See also | SkinnableContainer | |||
Type: Number CSS Inheritance: yes Alpha (transparency) value for the text. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Determines whether the text is underlined. See also | SkinnableContainer | |||
Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Specifies options for justifying text. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes Determines the number of degrees to rotate this text. See also | SkinnableContainer | |||
Type: Number CSS Inheritance: yes Theme: mobile Alpha of text shadows. | SkinnableContainer | |||
Type: uint Format: Color CSS Inheritance: yes Theme: mobile Color of text shadows. | SkinnableContainer | |||
Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | |||
Type: Number Format: Time CSS Inheritance: yes When in touch interaction mode, the number of milliseconds to wait after the user interaction has occured before showing the component in a visually down state. | SkinnableContainer | |||
Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the left of each character. See also | SkinnableContainer | |||
Type: Object CSS Inheritance: yes The amount of tracking (manual kerning) to be applied to the right of each character. See also | SkinnableContainer | |||
Type: String CSS Inheritance: yes The type of typographic case used for this text. See also | SkinnableContainer | |||
Type: uint Format: Color CSS Inheritance: yes The color of text when the component is enabled but does not have focus. | SkinnableContainer | |||
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: String CSS Inheritance: yes Collapses or preserves whitespace when importing text into a TextFlow. See also | SkinnableContainer | |||
Type: Object CSS Inheritance: yes Specifies the spacing between words to use during justification. See also | SkinnableContainer |
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
Skin Part | Description | Defined By | ||
---|---|---|---|---|
Required: false Part Type: Static An optional skin part that defines the Group where the content children get pushed into and laid out. | SkinnableContainer | |||
controlBarGroup:Group | Required: false Part Type: Static The skin part that defines the appearance of the control bar area of the container. By default, the ApplicationSkin class defines the control bar area to appear at the top of the content area of the Application container with a grey background. See also | Application |
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
applicationDPI | property |
applicationDPI:Number
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | AIR 2.5 |
The DPI of the application.
By default, this is the DPI of the device that the application is currently running on.
When set in MXML, Flex will scale the Application to match its DPI to the
runtimeDPI
.
This property cannot be set by ActionScript code; it must be set in MXML code.
public function get applicationDPI():Number
public function set applicationDPI(value:Number):void
See also
aspectRatio | property |
aspectRatio:String
[read-only] Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10.2, AIR 2.5 |
Returns the aspect ratio of the top level stage based on its width and height. If the width of the stage is greater than the height, the stage is considered to be in "landscape" orientation. Otherwise, portrait is returned.
public function get aspectRatio():String
colorCorrection | property |
colorCorrection:String
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The value of the stage's colorCorrection
property.
If this application does not have access to the stage's colorCorrection
property,
the value of the colorCorrection
property is null
.
Only the main application is allowed to set the colorCorrection
property. If a nested application's needs to set the color correction property, it
must set it by referencing the main application's instance.
The default value is ColorCorrection.DEFAULT
.
public function get colorCorrection():String
public function set colorCorrection(value:String):void
See also
controlBarContent | property |
controlBarContent:Array
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The set of components to include in the control bar area of the Application container. The location and appearance of the control bar area of the Application container is determined by the spark.skins.spark.ApplicationSkin class. By default, the ApplicationSkin class defines the control bar area to appear at the top of the content area of the Application container with a grey background. Create a custom skin to change the default appearance of the control bar.
The default value is null
.
public function get controlBarContent():Array
public function set controlBarContent(value:Array):void
See also
controlBarLayout | property |
controlBarLayout:LayoutBase
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Defines the layout of the control bar area of the container.
The default value is HorizontalLayout
.
public function get controlBarLayout():LayoutBase
public function set controlBarLayout(value:LayoutBase):void
controlBarVisible | property |
controlBarVisible:Boolean
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
If true
, the control bar is visible.
The flag has no affect if there is no value set for
the controlBarContent
property.
Note: The Application container does not monitor the
controlBarGroup
property.
If other code makes it invisible, the Application container might
not update correctly.
The default value is true
.
public function get controlBarVisible():Boolean
public function set controlBarVisible(value:Boolean):void
frameRate | property |
public var frameRate:Number
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
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
.
pageTitle | property |
public var pageTitle:String
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
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 value set in MXML code is designed to be used by a tool to update the HTML templates provided with the SDK.
The default value is ""
.
parameters | property |
parameters:Object
[read-only] Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
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).
public function get parameters():Object
preloader | property |
public var preloader:Object
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The application container supports an application preloader that uses a download progress bar to show the download and initialization progress of an application SWF file. By default, the application preloader is enabled. The preloader tracks how many bytes have been downloaded and continually updates the progress bar.
Use this property to specify the path of a component that defines a custom progress indicator. To create a custom progress indicator, you typically create a subclass of the SparkDownloadProgressBar or DownloadProgressBar class, or create a subclass of the flash.display.Sprite class that implements the mx.preloaders.IPreloaderDisplay interface.
Note: This property cannot be set by ActionScript code; it must be set in MXML code.
See also
preloaderChromeColor | property |
public var preloaderChromeColor:uint
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Specifies the chrome color used by the default preloader component. This property
has the same effect as the chromeColor
style used by Spark skins.
Typically this property should be set to the same value as the
Application container's chromeColor
style property.
Note: This property cannot be set by ActionScript code; it must be set in MXML code.
resizeForSoftKeyboard | property |
resizeForSoftKeyboard:Boolean
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | AIR 2.5 |
Some devices do not support a hardware keyboard.
Instead, these devices use a keyboard that opens on
the screen when necessary.
The screen keyboard, also called a soft or virtual keyboard,
closes after the user enters the information, or when the user cancels the operation.
A value of true
means the application
is resized when the soft keyboard is open or
closed.
To enable application resizing, you must also set the
<softKeyboardBehavior>
attribute in the
application's xml descriptor file to none
.
The default value is false
.
public function get resizeForSoftKeyboard():Boolean
public function set resizeForSoftKeyboard(value:Boolean):void
runtimeDPI | property |
runtimeDPI:Number
[read-only] Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | AIR 2.5 |
The DPI of the device the application is currently running on.
Flex rounds the value to one of the DPIClassification
choices.
public function get runtimeDPI():Number
See also
runtimeDPIProvider | property |
runtimeDPIProvider:Class
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | AIR 2.5 |
A class that extends RuntimeDPIProvider and overrides the default Flex
calculations for runtimeDPI
.
Flex's default mappings are:
160 DPI | <140 DPI |
160 DPI | >=140 DPI and <=200 DPI |
240 DPI | >=200 DPI and <=280 DPI |
320 DPI | >=280 DPI and <=400 DPI |
480 DPI | >=400 DPI and <=560 DPI |
640 DPI | >=640 DPI |
The default value is spark.components.RuntimeDPIProvider
.
public function get runtimeDPIProvider():Class
public function set runtimeDPIProvider(value:Class):void
See also
scriptRecursionLimit | property |
public var scriptRecursionLimit:int
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
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
.
scriptTimeLimit | property |
public var scriptTimeLimit:Number
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
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
.
splashScreenImage | property |
splashScreenImage:Class
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
The image class for the SplashScreen preloader.
Typically you set this property to either an embedded resource
or the name of a SplashScreenImage
class defined in a separate MXML file.
Example of setting splashScreenImage to an embedded image:
splashScreenImage="@Embed('Default.png')"
Note: The property has effect only when the preloader
property is set to spark.preloaders.SplashScreen.
The spark.preloaders.SplashScreen class is the default preloader for Mobile Flex applications.
This property cannot be set by ActionScript code; it must be set in MXML code.
Note: You must add the frameworks\libs\mobile\mobilecomponents.swc to the library path of the application to support the splash screen in a desktop application.
public function get splashScreenImage():Class
public function set splashScreenImage(value:Class):void
See also
splashScreenMinimumDisplayTime | property |
public var splashScreenMinimumDisplayTime:Number
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Minimum amount of time, in milliseconds, to show the splash screen image.
Specify the splash screen image by using the splashScreenImage
property.
Note: The property has effect only when the splashScreenImage
property
is set and the preloader
property is set to spark.preloaders.SplashScreen.
The spark.preloaders.SplashScreen class is the default preloader for Mobile Flex applications.
This property cannot be set by ActionScript code; it must be set in MXML code.
Note: You must add the frameworks\libs\mobile\mobilecomponents.swc to the library path of the application to support the splash screen in a desktop application.
The default value is 1000
.
See also
splashScreenScaleMode | property |
public var splashScreenScaleMode:String
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
The splash screen image scale mode:
none
implies that the image size is set
to match its intrinsic size.stretch
sets the width and the height of the image to the
stage width and height, possibly changing the content aspect ratio.letterbox
sets the width and height of the image
as close to the stage width and height as possible while maintaining aspect ratio.
The image is stretched to a maximum of the stage bounds,
with spacing added inside the stage to maintain the aspect ratio if necessary.zoom
is similar to letterbox
, except
that zoom
stretches the image past the bounds of the stage,
to remove the spacing required to maintain aspect ratio.
This setting has the effect of using the entire bounds of the stage, but also
possibly cropping some of the image.The portion of the stage that is not covered by the image shows
in the Application container's backgroundColor
.
Note: The property has effect only when the splashScreenImage
property
is set and the preloader
property is set to spark.preloaders.SplashScreen.
The spark.preloaders.SplashScreen class is the default preloader for Mobile Flex applications.
This property cannot be set by ActionScript code; it must be set in MXML code.
Note: You must add the frameworks\libs\mobile\mobilecomponents.swc to the library path of the application to support the splash screen in a desktop application.
The default value is "none"
.
See also
url | property |
url:String
[read-only] Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The URL from which this Application's SWF file was loaded.
public function get url():String
usePreloader | property |
public var usePreloader:Boolean
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
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
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
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:
<Application viewSourceURL="http://path/to/source"> ... </Application>
public function get viewSourceURL():String
public function set viewSourceURL(value:String):void
Application | () | Constructor |
public function Application()
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Constructor.
applicationComplete | Event |
mx.events.FlexEvent
mx.events.FlexEvent.APPLICATION_COMPLETE
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Dispatched after the Application has been initialized, processed by the LayoutManager, and attached to the display list.
TheFlexEvent.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
flash.events.ErrorEvent.ERROR
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Dispatched when an HTTPService call fails.
uncaughtError | Event |
flash.events.UncaughtErrorEvent
flash.events.UncaughtErrorEvent.UNCAUGHT_ERROR
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10.1, AIR 2.0 |
Dispatched when an uncaught error is caught by the Global Exception Handler
<?xml version="1.0" encoding="utf-8"?> <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <!-- Simple example to demonstrate Spark Application component --> <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:mx="library://ns.adobe.com/flex/mx" xmlns:s="library://ns.adobe.com/flex/spark"> <s:layout> <s:VerticalLayout paddingTop="10" paddingLeft="10"/> </s:layout> <!-- Define the controls for the control bar area. --> <s:controlBarContent> <mx:MenuBar height="100%" dataProvider="{menuXML}" labelField="@label" showRoot="true"/> <s:HGroup paddingBottom="5" paddingTop="5"> <s:TextInput id="myTI" text=""/> <!-- Open the Alert control when selected. --> <s:Button id="srch1" label="Search" click="Alert.show('Searching');"/> </s:HGroup> </s:controlBarContent> <!-- Import the Alert control. --> <fx:Script> <![CDATA[ import mx.controls.Alert; ]]> </fx:Script> <fx:Declarations> <fx:XMLList id="menuXML"> <fx:menuitem label="File"> <fx:menuitem label="New" data="New"/> <fx:menuitem label="Open" data="Open"/> <fx:menuitem label="Save" data="Save"/> <fx:menuitem label="Exit" data="Exit"/> </fx:menuitem> <fx:menuitem label="Edit"> <fx:menuitem label="Cut" data="Cut"/> <fx:menuitem label="Copy" data="Copy"/> <fx:menuitem label="Paste" data="Paste"/> </fx:menuitem> <fx:menuitem label="View"/> </fx:XMLList> </fx:Declarations> <s:Panel title="Spark Application Container Example" width="75%" height="75%"> <mx:TextArea text="An Application container with a control bar area." width="300" height="200" color="blue"/> </s:Panel> </s:Application>