Package | mx.controls |
Class | public class SWFLoader |
Inheritance | SWFLoader UIComponent FlexSprite flash.display.Sprite |
Implements | ISWFLoader |
Note: You can use the SWFLoader control to load
a GIF, JPEG, or PNG image file at runtime,
to load a ByteArray representing a SWF, GIF, JPEG, or PNG image at runtime,
or load an embedded version of any of these file types,
and SVG files, at compile time
by using @Embed(source='filename')
.
However, the Image control is better suited for this capability
and should be used for most image loading.
The Image control is also designed to be used
in custom item renderers and item editors.
When using either SWFLoader or Image with an SVG file,
you can only load the SVG if it has been embedded in your
application using an Embed statement;
you cannot load an SVG from the network at runtime.
The SWFLoader control lets you scale its content and set its size. It can also resize itself to fit the size of its content. By default, content is scaled to fit the size of the SWFLoader control. It can also load content on demand programmatically, and monitor the progress of a load.
A SWFLoader control cannot receive focus. However, the contents of a SWFLoader control can accept focus and have its own focus interactions.
The SWFLoader control has the following default characteristics:
Characteristic | Description |
---|---|
Default size | Width and height large enough for the loaded content |
Minimum size | 0 pixels |
Maximum size | Undefined |
The <mx:SWFLoader> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:
<mx:SWFLoader Properties autoLoad="true|false" loadForCompatibility="false|true" loaderContext="null" maintainAspectRatio="true|false" scaleContent="true|false" showBusyCursor="false|true" source="No default" trustContent="false|true" Styles brokenImageBorderSkin="BrokenImageBorderSkin" brokenImageSkin="'__brokenImage' symbol in Assets.swf" horizontalAlign="left|center|right" verticalAlign="top|middle|bottom" Effects completeEffect="No default" Events complete="No default" httpStatus="No default" init="No default" ioError="No default" open="No default" progress="No default" securityError="No default" unload="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 | ||
autoLoad : Boolean
A flag that indicates whether content starts loading automatically
or waits for a call to the
load() method. | SWFLoader | ||
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 | ||
bytesLoaded : Number [read-only]
The number of bytes of the SWF or image file already loaded.
| SWFLoader | ||
bytesTotal : Number [read-only]
The total size of the SWF or image file.
| SWFLoader | ||
cacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
| UIComponent | ||
cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | ||
childAllowsParent : Boolean [read-only]
Tests if the child allows its parent to access its display objects or listen
to messages that originate in the child.
| SWFLoader | ||
className : String
The name of this instance's class, such as
"Button" . | UIComponent | ||
content : DisplayObject [read-only]
This property contains the object that represents
the content that was loaded in the SWFLoader control.
| SWFLoader | ||
contentHeight : Number [read-only]
Height of the scaled content loaded by the control, in pixels.
| SWFLoader | ||
contentMouseX : Number
Returns the x position of the mouse, in the content coordinate system.
| UIComponent | ||
contentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
| UIComponent | ||
contentWidth : Number [read-only]
Width of the scaled content loaded by the control, in pixels.
| SWFLoader | ||
currentLooperData : Object
When using this component as the child of a DataLooper element, this holds the current element's corresponding looping data.
| UIComponent | ||
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 | ||
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
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
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 | ||
globalX : Number | UIComponent | ||
globalY : Number | UIComponent | ||
height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| 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
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 | ||
loaderContext : LoaderContext
A LoaderContext object to use to control loading of the content.
| SWFLoader | ||
loadForCompatibility : Boolean
A flag that indicates whether the content is loaded so that it can
interoperate with applications built with a different verion of the Flex compiler.
| SWFLoader | ||
maintainAspectRatio : Boolean
A flag that indicates whether to maintain the aspect ratio
of the loaded content.
| SWFLoader | ||
maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | ||
measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | ||
measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | ||
measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | ||
minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
miscHolder : Object
A utility holder for any various properties
| 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 | ||
move_enableProtection : Boolean = false | 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 | ||
owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | ||
parent : DisplayObjectContainer
The parent container or component for this component.
| UIComponent | ||
parentAllowsChild : Boolean [read-only]
Tests if the parent allows its child to access its display objects or listen
to messages that originate in the parent.
| SWFLoader | ||
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 | ||
percentLoaded : Number [read-only]
The percentage of the image or SWF file already loaded.
| SWFLoader | ||
percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | ||
processedDescriptors : Boolean
Set to
true after immediate or deferred child creation,
depending on which one happens. | UIComponent | ||
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 | ||
scaleContent : Boolean
A flag that indicates whether to scale the content to fit the
size of the control or resize the control to the content's size.
| SWFLoader | ||
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 | ||
setActualSize_enableProtection : Boolean = false | UIComponent | ||
setVisible_enableProtection : Boolean = true | UIComponent | ||
showBusyCursor : Boolean
A flag that indicates whether to show a busy cursor while
the content loads.
| SWFLoader | ||
showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | ||
source : Object
The URL, object, class or string name of a class to
load as the content.
| SWFLoader | ||
states : Array
The view states that are defined for this component.
| UIComponent | ||
styleClassOverridesInline : Boolean = true
Specifies if class-specific styles (as defined by the
styleName property) override inline styles. | UIComponent | ||
styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | ||
styleName : Object
The class style used by this component.
| UIComponent | ||
swfBridge : IEventDispatcher [read-only]
A bridge to the application that is associated with the implementor of this
interface.
| SWFLoader | ||
systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | ||
toolTip : String
Text to display in the ToolTip.
| 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 | ||
trustContent : Boolean
If
true , the content is loaded
into your security domain. | SWFLoader | ||
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 | ||
validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | ||
visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | ||
visible_unprotected : Boolean
If setVisible_enableProtection is enabled, this allows access to determine what the pseudo-state is -- that is, what's been requested, regardless of any prevention of default behavior.
| UIComponent | ||
width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | ||
x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | ||
xmlDescriptor : XML
For certain dynamically created elements, this represents the XML node used to create that element.
| UIComponent | ||
y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent |
Method | Defined by | ||
---|---|---|---|
Constructor.
| SWFLoader | ||
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 | ||
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, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
| UIComponent | ||
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 the data bindings into this UIComponent object.
| UIComponent | ||
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 | ||
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 | ||
getDescendantByName(name:String):DisplayObject
Searches all children for the first child named with the passed value; returns that child, or null if not found.
| UIComponent | ||
getDescendantsByName(name:String):Array
Searches all children for all children named with the passed value; returns an array with those children, or an empty array if none found.
| 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 | ||
getVisibleApplicationRect(allApplications:Boolean = false):Rectangle
Get the bounds of the loaded application that are visible to the user
on the screen.
| SWFLoader | ||
getVisibleRect(targetParent:DisplayObject = null):Rectangle
MOVED OVER FROM SDK 3.2 UIComponent - Allows for popped-up alerts to be displayed correctly - NGR MOVED 11-20-08
| UIComponent | ||
globalToContent(point:Point):Point
Converts a
Point object from global to content coordinates. | 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 | ||
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 | ||
load(url:Object = null):void
Loads an image or SWF file.
| SWFLoader | ||
localToContent(point:Point):Point
Converts a
Point object from local to content coordinates. | UIComponent | ||
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 | ||
move_unprotected(x:Number, y:Number):void
Same as move, but cannot be prevented via the protection_move event.
| 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 | ||
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 | ||
setActualSize_unprotected(w:Number, h:Number):void
Same as setActualSize, but is not cancelable via the protection_size event.
| 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 | ||
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 | ||
setVisible_unprotected(value:Boolean, noEvent:Boolean = false):void
Same as setVisible, but cannot be prevented.
| 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 | ||
unloadAndStop(invokeGarbageCollector:Boolean = true):void
Unloads an image or SWF file.
| SWFLoader | ||
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 when content loading is complete. | SWFLoader | |||
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 the component has returned to the root view state. | UIComponent | |||
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 a network request is made over HTTP and Flash Player or AIR can detect the HTTP status code. | SWFLoader | |||
Dispatched when the properties and methods of a loaded SWF file are accessible. | SWFLoader | |||
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 when an input/output error occurs. | SWFLoader | |||
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 when a network operation starts. | SWFLoader | |||
Dispatched at the beginning of the component initialization sequence. | UIComponent | |||
Dispatched when content is loading. | SWFLoader | |||
Dispatched when the component is about to be hidden (visible = false); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is about to be moved via move(); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is about to be shown (visible = true); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is about to be sized via setActualSize(); calling event.preventDefault() will stop the action from occuring. | 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 a security error occurs while content is loading. | SWFLoader | |||
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 a loaded object is removed, or when a second load is performed by the same SWFLoader control and the original content is removed prior to the new load beginning. | SWFLoader | |||
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: 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: 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: Number CSS Inheritance: no The color brightness of the component. | UIComponent | |||
brokenImageBorderSkin
| Type: Class CSS Inheritance: no The name of class to use as the SWFLoader border skin if the control cannot load the content. The default value is BrokenImageBorderSkin . | SWFLoader | ||
brokenImageSkin
| Type: Class CSS Inheritance: no The name of the class to use as the SWFLoader skin if the control cannot load the content. The default value is the "__brokenImage" symbol in the Assets.swf file. | SWFLoader | ||
Type: Number CSS Inheritance: no The color contrast of the component. | UIComponent | |||
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 | |||
horizontalAlign
| Type: String CSS Inheritance: no The horizontal alignment of the content when it does not have a one-to-one aspect ratio. Possible values are "left" , "center" ,
and "right" .
The default value is "left" . | SWFLoader | ||
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 CSS Inheritance: no The color hue of the component. | UIComponent | |||
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: no The opacity of the component. | UIComponent | |||
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: Number CSS Inheritance: no The color saturation of the component. | UIComponent | |||
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 | |||
verticalAlign
| Type: String CSS Inheritance: no The vertical alignment of the content when it does not have a one-to-one aspect ratio. Possible values are "top" , "middle" ,
and "bottom" .
The default value is "top" . | SWFLoader | ||
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 |
Effect | Description | Defined by | ||
---|---|---|---|---|
Triggering event: added Played when the component is added as a child to a Container. | UIComponent | |||
completeEffect
| Triggering event: complete
An effect that is started when the complete event is dispatched. | SWFLoader | ||
Triggering event: creationComplete
Played when the component is created. | UIComponent | |||
Triggering event: focusIn Played when the component gains keyboard focus. | UIComponent | |||
Triggering event: focusOut Played when the component loses keyboard focus. | UIComponent | |||
Triggering event: hide
Played when the component becomes invisible. | UIComponent | |||
Triggering event: mouseDown Played when the user presses the mouse button while over the component. | UIComponent | |||
Triggering event: mouseUp Played when the user releases the mouse button while over the component. | UIComponent | |||
Triggering event: move
Played when the component is moved. | UIComponent | |||
Triggering event: removed Played when the component is removed from a Container. | UIComponent | |||
Triggering event: resize
Played when the component is resized. | UIComponent | |||
Triggering event: rollOut Played when the user rolls the mouse so it is no longer over the component. | UIComponent | |||
Triggering event: rollOver Played when the user rolls the mouse over the component. | UIComponent | |||
Triggering event: show
Played when the component becomes visible. | UIComponent |
autoLoad | property |
autoLoad:Boolean
[read-write]
A flag that indicates whether content starts loading automatically
or waits for a call to the load()
method.
If true
, the content loads automatically.
If false
, you must call the load()
method.
The default value is true
.
This property can be used as the source for data binding.
Implementation public function get autoLoad():Boolean
public function set autoLoad(value:Boolean):void
bytesLoaded | property |
bytesLoaded:Number
[read-only]The number of bytes of the SWF or image file already loaded.
This property can be used as the source for data binding.
Implementation public function get bytesLoaded():Number
bytesTotal | property |
bytesTotal:Number
[read-only]The total size of the SWF or image file.
This property can be used as the source for data binding.
Implementation public function get bytesTotal():Number
childAllowsParent | property |
childAllowsParent:Boolean
[read-only]
Tests if the child allows its parent to access its display objects or listen
to messages that originate in the child.
true
if access if allowed; otherwise false
.
public function get childAllowsParent():Boolean
content | property |
content:DisplayObject
[read-only]This property contains the object that represents the content that was loaded in the SWFLoader control.
Implementation public function get content():DisplayObject
contentHeight | property |
contentHeight:Number
[read-only]
Height of the scaled content loaded by the control, in pixels.
Note that this is not the height of the control itself, but of the
loaded content. Use the height
property of the control
to obtain its height.
The value of this property is not final when the complete
event is triggered.
You can get the value after the updateComplete
event is triggered.
The default value is NaN
.
public function get contentHeight():Number
contentWidth | property |
contentWidth:Number
[read-only]
Width of the scaled content loaded by the control, in pixels.
Note that this is not the width of the control itself, but of the
loaded content. Use the width
property of the control
to obtain its width.
The value of this property is not final when the complete
event is triggered.
You can get the value after the updateComplete
event is triggered.
The default value is NaN
.
public function get contentWidth():Number
loaderContext | property |
loaderContext:LoaderContext
[read-write]
A LoaderContext object to use to control loading of the content.
This is an advanced property.
Most of the time you can use the trustContent
property.
The default value is null
, which causes the control
to use the trustContent
property to create
a LoaderContext object, which you can read back
after the load starts.
To use a custom LoaderContext object, you must understand the
SecurityDomain and ApplicationDomain classes.
Setting this property will not start a load;
you must set this before the load starts.
This does not mean that you have to set autoLoad
property
to false
, because the load does not actually start
immediately, but waiting for the creationComplete
event
to set it is too late.
The default value is null
.
This property can be used as the source for data binding.
Implementation public function get loaderContext():LoaderContext
public function set loaderContext(value:LoaderContext):void
See also
loadForCompatibility | property |
loadForCompatibility:Boolean
[read-write]
A flag that indicates whether the content is loaded so that it can
interoperate with applications built with a different verion of the Flex compiler.
Compatibility with other Flex applications is accomplished by loading
the application into a sibling (or peer) ApplicationDomain.
This flag is ignored if the content must be loaded into a different
SecurityDomain.
If true
, the content loads into a sibling ApplicationDomain.
If false
, the content loaded into a child ApplicationDomain.
The default value is false
.
This property can be used as the source for data binding.
Implementation public function get loadForCompatibility():Boolean
public function set loadForCompatibility(value:Boolean):void
maintainAspectRatio | property |
maintainAspectRatio:Boolean
[read-write]
A flag that indicates whether to maintain the aspect ratio
of the loaded content.
If true
, specifies to display the image with the same ratio of
height to width as the original image.
The default value is true
.
This property can be used as the source for data binding.
Implementation public function get maintainAspectRatio():Boolean
public function set maintainAspectRatio(value:Boolean):void
parentAllowsChild | property |
parentAllowsChild:Boolean
[read-only]
Tests if the parent allows its child to access its display objects or listen
to messages that originate in the parent.
true
if access if allowed; otherwise false
.
public function get parentAllowsChild():Boolean
percentLoaded | property |
percentLoaded:Number
[read-only]The percentage of the image or SWF file already loaded.
The default value is 0
.
This property can be used as the source for data binding.
Implementation public function get percentLoaded():Number
scaleContent | property |
scaleContent:Boolean
[read-write]
A flag that indicates whether to scale the content to fit the
size of the control or resize the control to the content's size.
If true
, the content scales to fit the SWFLoader control.
If false
, the SWFLoader scales to fit the content.
The default value is true
.
This property can be used as the source for data binding.
Implementation public function get scaleContent():Boolean
public function set scaleContent(value:Boolean):void
showBusyCursor | property |
showBusyCursor:Boolean
[read-write]
A flag that indicates whether to show a busy cursor while
the content loads.
If true
, shows a busy cursor while the content loads.
The default busy cursor is the mx.skins.halo.BusyCursor
as defined by the busyCursor
property of the CursorManager class.
The default value is false
.
public function get showBusyCursor():Boolean
public function set showBusyCursor(value:Boolean):void
See also
source | property |
source:Object
[read-write]
The URL, object, class or string name of a class to
load as the content.
The source
property takes the following form:
source="URLOrPathOrClass"
source="@Embed(source='PathOrClass')"
The value of the source
property represents
a relative or absolute URL; a ByteArray representing a
SWF, GIF, JPEG, or PNG; an object that implements
IFlexDisplayObject; a class whose type implements IFlexDisplayObject;
or a String that represents a class.
When you specify a path to a SWF, GIF, JPEG, PNG, or SVG file, Flex automatically converts the file to the correct data type for use with the SWFLoader control.
If you omit the Embed statement, Flex loads the referenced file at runtime;
it is not packaged as part of the generated SWF file.
At runtime, the source
property only supports the loading of
GIF, JPEG, PNG images, and SWF files.
Flex Data Services users can use the SWFLoader control to load a Flex application by using the following form:
source="MXMLPath.mxml.swf"
Flex Data Services compiles the MXML file, and returns the SWF file to the main application. This technique works well with SWF files that add graphics or animations to an application, but are not intended to have a large amount of user interaction. If you import SWF files that require a large amount of user interaction, you should build them as custom components.
The default value is null
.
This property can be used as the source for data binding.
Implementation public function get source():Object
public function set source(value:Object):void
swfBridge | property |
swfBridge:IEventDispatcher
[read-only]A bridge to the application that is associated with the implementor of this interface. The IEventDispatcher that can be used to send events to an application in a different ApplicationDomain or a different sandbox.
Implementation public function get swfBridge():IEventDispatcher
trustContent | property |
trustContent:Boolean
[read-write]
If true
, the content is loaded
into your security domain.
This means that the load fails if the content is in another domain
and that domain does not have a crossdomain.xml file allowing your
domain to access it.
This property only has an affect on the next load,
it will not start a new load on already loaded content.
The default value is false
, which means load
any content without failing, but you cannot access the content.
Most importantly, the loaded content cannot
access your objects and code, which is the safest scenario.
Do not set this property to true
unless you are absolutely sure of the safety
of the loaded content, especially active content like SWF files.
You can also use the loaderContext
property
to exactly determine how content gets loaded,
if setting trustContent
does not exactly
meet your needs.
The loaderContext
property causes the SWFLoader
to ignore the value of the trustContent
property.
But, you should be familiar with the SecurityDomain
and ApplicationDomain classes to use the loaderContext
property.
The default value is false
.
This property can be used as the source for data binding.
Implementation public function get trustContent():Boolean
public function set trustContent(value:Boolean):void
See also
SWFLoader | () | constructor |
public function SWFLoader()
Constructor.
getVisibleApplicationRect | () | method |
public function getVisibleApplicationRect(allApplications:Boolean = false):Rectangle
Get the bounds of the loaded application that are visible to the user on the screen.
ParametersallApplications:Boolean (default = false ) — Determine if the visible rectangle is calculated based only on the
display objects in this application or all parent applications as well.
Including more parent applications might reduce the visible area returned.
If true , then all applications are used to find the visible
area, otherwise only the display objects in this application are used.
|
Rectangle — A Rectangle that includes the visible portion of this
object. The rectangle uses global coordinates.
|
load | () | method |
public function load(url:Object = null):void
Loads an image or SWF file.
The url
argument can reference a GIF, JPEG, PNG,
or SWF file; you cannot use this method to load an SVG file.
Instead, you must load it using an Embed statement
with the source
property.
url:Object (default = null ) — Absolute or relative URL of the GIF, JPEG, PNG,
or SWF file to load.
|
unloadAndStop | () | method |
public function unloadAndStop(invokeGarbageCollector:Boolean = true):void
Unloads an image or SWF file. After this method returns the
source
property will be null. This is only supported
if the host Flash Player is version 10 or greater. If the host Flash
Player is less than version 10, then this method will unload the
content the same way as if source
was set to null.
This method attempts to unload SWF files by removing references to
EventDispatcher, NetConnection, Timer, Sound, or Video objects of the
child SWF file. As a result, the following occurs for the child SWF file
and the child SWF file's display list:
enterFrame
,
frameConstructed
, exitFrame
,
activate
and deactivate
are removed.invokeGarbageCollector:Boolean (default = true ) — (default = true )
— Provides a hint to the garbage collector to run
on the child SWF objects (true ) or not (false ).
If you are unloading many objects asynchronously, setting the
gc parameter to false might improve application
performance. However, if the parameter is set to false , media
and display objects of the child SWF file might persist in memory after
the child SWF has been unloaded.
|
complete | event |
flash.events.Event
Dispatched when content loading is complete.
This event is dispatched regardless of whether the load was triggered
by an autoload or an explicit call to the load()
method.
httpStatus | event |
flash.events.HTTPStatusEvent
Dispatched when a network request is made over HTTP and Flash Player or AIR can detect the HTTP status code.
init | event |
flash.events.Event
Dispatched when the properties and methods of a loaded SWF file are accessible. The following two conditions must exist for this event to be dispatched:
ioError | event |
flash.events.IOErrorEvent
Dispatched when an input/output error occurs.
See also
open | event |
progress | event |
flash.events.ProgressEvent
Dispatched when content is loading.
This event is dispatched regardless of whether the load was triggered
by an autoload or an explicit call to the load()
method.
Note:
The progress
event is not guaranteed to be dispatched.
The complete
event may be received, without any
progress
events being dispatched.
This can happen when the loaded content is a local file.
securityError | event |
flash.events.SecurityErrorEvent
Dispatched when a security error occurs while content is loading. For more information, see the SecurityErrorEvent class.
unload | event |
flash.events.Event
Dispatched when a loaded object is removed, or when a second load is performed by the same SWFLoader control and the original content is removed prior to the new load beginning.