fl.containers.UILoader (ActionScript 3.0)

Package	fl.containers
Class	public class UILoader
Inheritance	UILoader UIComponent Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object

Language Version :

ActionScript 3.0

Runtime Versions :

AIR 1.0, Flash Player 9.0.28.0

The UILoader class makes it possible to set content to load and to then monitor the loading operation at run time. This class also handles the resizing of the loaded content. If loading content from a different domain (sandbox), security implications may mean content properties are inaccessible. Please see the Loader class for more information.

Using ActionScript to set a property of the UILoader class overrides the parameter of the same name that is set in the Property inspector or Component inspector.

This component wraps flash.display.Loader. The Loader class handles all the actual loading; the UILoader just provides a visual display for the Loader object.

Note: When content is being loaded from a different domain or sandbox, the properties of the content may be inaccessible for security reasons. For more information about how domain security affects the load process, see the Loader class.

View the examples

See also

Loader

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		accessibilityProperties : AccessibilityProperties The current accessibility options for this display object.	DisplayObject
		alpha : Number Indicates the alpha transparency value of the object specified.	DisplayObject
		autoLoad : Boolean Gets or sets a value that indicates whether the UILoader instance automatically loads the specified content.	UILoader
		blendMode : String A value from the BlendMode class that specifies which blend mode to use.	DisplayObject
		buttonMode : Boolean Specifies the button mode of this sprite.	Sprite
		bytesLoaded : uint [read-only] Gets the count of bytes of content that have been loaded.	UILoader
		bytesTotal : uint [read-only] Gets the count of bytes of content to be loaded.	UILoader
		cacheAsBitmap : Boolean If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the display object.	DisplayObject
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		content : DisplayObject [read-only] Contains the root display object of the SWF file or image file (a JPEG, PNG, or GIF format file) that was loaded by using the load() method or setting the source property.	UILoader
		contextMenu : NativeMenu Specifies the context menu associated with this object.	InteractiveObject
		doubleClickEnabled : Boolean Specifies whether the object receives doubleClick events.	InteractiveObject
		dropTarget : DisplayObject [read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.	Sprite
		enabled : Boolean Gets or sets a value that indicates whether the component can accept user interaction.	UIComponent
		filters : Array An indexed array that contains each filter object currently associated with the display object.	DisplayObject
		focusEnabled : Boolean Gets or sets a Boolean value that indicates whether the component can receive focus after the user clicks it.	UIComponent
		focusManager : IFocusManager Gets or sets the FocusManager that controls focus for this component and its peers.	UIComponent
		focusRect : Object Specifies whether this object displays a focus rectangle.	InteractiveObject
		graphics : Graphics [read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.	Sprite
		height : Number Gets or sets the height of the component, in pixels.	UIComponent
		hitArea : Sprite Designates another sprite to serve as the hit area for a sprite.	Sprite
		loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.	DisplayObject
		maintainAspectRatio : Boolean Gets or sets a value that indicates whether to maintain the aspect ratio that was used in the original image or to resize the image at the curent width and height of the UILoader component.	UILoader
		mask : DisplayObject The calling display object is masked by the specified mask object.	DisplayObject
		mouseChildren : Boolean Determines whether or not the children of the object are mouse enabled.	DisplayObjectContainer
		mouseEnabled : Boolean Specifies whether this object receives mouse messages.	InteractiveObject
		mouseFocusEnabled : Boolean Gets or sets a value that indicates whether the component can receive focus after the user clicks it.	UIComponent
		mouseX : Number [read-only] Indicates the x coordinate of the mouse position, in pixels.	DisplayObject
		mouseY : Number [read-only] Indicates the y coordinate of the mouse position, in pixels.	DisplayObject
		name : String Indicates the instance name of the DisplayObject.	DisplayObject
		numChildren : int [read-only] Returns the number of children of this object.	DisplayObjectContainer
		opaqueBackground : Object Specifies whether the display object is opaque with a certain background color.	DisplayObject
		parent : DisplayObjectContainer [read-only] Indicates the DisplayObjectContainer object that contains this display object.	DisplayObject
		percentLoaded : Number [read-only] Gets a number between 0 and 100 indicating what percentage of the content is loaded.	UILoader
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		root : DisplayObject [read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.	DisplayObject
		rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.	DisplayObject
		scale9Grid : Rectangle The current scaling grid that is in effect.	DisplayObject
		scaleContent : Boolean Gets or sets a value that indicates whether to automatically scale the image to the size of the UILoader instance.	UILoader
		scaleX : Number Multiplies the current width of the component by a scale factor.	UIComponent
		scaleY : Number Multiplies the current height of the component by a scale factor.	UIComponent
		scrollRect : Rectangle The scroll rectangle bounds of the display object.	DisplayObject
		soundTransform : SoundTransform Controls sound within this sprite.	Sprite
		source : Object Gets or sets an absolute or relative URL that identifies the location of the SWF or image file to load, the class name of a movie clip in the library, a reference to a display object, or a instance name of a movie clip on the same level as the component.	UILoader
		stage : Stage [read-only] The Stage of the display object.	DisplayObject
		tabChildren : Boolean Determines whether the children of the object are tab enabled.	DisplayObjectContainer
		tabEnabled : Boolean Specifies whether this object is in the tab order.	InteractiveObject
		tabIndex : int Specifies the tab ordering of objects in a SWF file.	InteractiveObject
		textSnapshot : TextSnapshot [read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.	DisplayObjectContainer
		transform : Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	DisplayObject
		useHandCursor : Boolean A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls over a sprite in which the buttonMode property is set to true.	Sprite
		version : String = "3.0.0.15" The version number of the components.	UIComponent
		visible : Boolean Gets or sets a value that indicates whether the current component instance is visible.	UIComponent
		width : Number Gets or sets the width of the component, in pixels.	UIComponent
		x : Number Gets or sets the x coordinate that represents the position of the component along the x axis within its parent container.	UIComponent
		y : Number Gets or sets the y coordinate that represents the position of the component along the y axis within its parent container.	UIComponent

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		UILoader() Creates a new UILoader component instance.	UILoader
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		areInaccessibleObjectsUnderPoint(point:Point):Boolean Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.	DisplayObjectContainer
		clearStyle(style:String):void Deletes a style property from this component instance.	UIComponent
		close():void Cancels a load() method operation that is currently in progress for the Loader instance.	UILoader
		contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.	DisplayObjectContainer
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		drawFocus(focused:Boolean):void Shows or hides the focus indicator on this component.	UIComponent
		drawNow():void Initiates an immediate draw operation, without invalidating everything as invalidateNow does.	UIComponent
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.	DisplayObject
		getChildAt(index:int):DisplayObject Returns the child display object instance that exists at the specified index.	DisplayObjectContainer
		getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name.	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int Returns the index position of a child DisplayObject instance.	DisplayObjectContainer
		getFocus():InteractiveObject Retrieves the object that currently has focus.	UIComponent
		getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.	DisplayObjectContainer
		getRect(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.	DisplayObject
		getStyle(style:String):Object Retrieves a style property that is set in the style lookup chain of the component.	UIComponent
		getStyleDefinition():Object [static] Retrieves the default style map for the current component.	UILoader
		globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	DisplayObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hitTestObject(obj:DisplayObject):Boolean Evaluates the display object to see if it overlaps or intersects with the obj display object.	DisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.	DisplayObject
		invalidate(property:String, callLater:Boolean = true):void Marks a property as invalid and redraws the component on the next frame unless otherwise specified.	UIComponent
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		load(request:URLRequest = null, context:LoaderContext = null):void Loads the specified content or, if no content is specified, loads the content from the location identified by the source property.	UILoader
		loadBytes(bytes:ByteArray, context:LoaderContext = null):void Loads binary data that is stored in a ByteArray object.	UILoader
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		mergeStyles(... list):Object [static] Merges the styles from multiple classes into one object.	UIComponent
		move(x:Number, y:Number):void Moves the component to the specified position within its parent.	UIComponent
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeChild(child:DisplayObject):DisplayObject Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.	DisplayObjectContainer
		removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.	DisplayObjectContainer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setChildIndex(child:DisplayObject, index:int):void Changes the position of an existing child in the display object container.	DisplayObjectContainer
		setFocus():void Sets the focus to this component.	UIComponent
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setSize(w:Number, h:Number):void Resizes the component to the requested size.	UILoader
		setStyle(style:String, value:Object):void Sets a style property on this component instance.	UIComponent
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite.	Sprite
		stopDrag():void Ends the startDrag() method.	Sprite
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects.	DisplayObjectContainer
		swapChildrenAt(index1:int, index2:int):void Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.	DisplayObjectContainer
		toString():String Returns the string representation of the specified object.	Object
		unload():void Removes a child of this UILoader object that was loaded by using either the load() method or the source property.	UILoader
		validateNow():void Validates and updates the properties and layout of this object, redrawing it if necessary.	UIComponent
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

	Method	Defined By
		getStyleValue(name:String):Object Returns the specified style for a component, considering all styles set on the global level, component level and instance level.	UIComponent

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	Dispatched when Flash Player or an AIR application gains operating system focus and becomes active.	EventDispatcher
added	Dispatched when a display object is added to the display list.	DisplayObject
addedToStage	Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.	DisplayObject
click	Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.	InteractiveObject
complete	Dispatched when content loading is complete.	UILoader
contextMenu	Dispatched when the user selects the context menu associated with this interactive object in an AIR application.	InteractiveObject
deactivate	Dispatched when Flash Player or an AIR application loses operating system focus and is becoming inactive.	EventDispatcher
doubleClick	Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.	InteractiveObject
enterFrame	Dispatched when the playhead is entering a new frame.	DisplayObject
focusIn	Dispatched after a display object gains focus.	InteractiveObject
focusOut	Dispatched after a display object loses focus.	InteractiveObject
hide	Dispatched after the component visibility changes from visible to invisible.	UIComponent
init	Dispatched when the properties and methods of a loaded SWF file are accessible.	UILoader
ioError	Dispatched after an input or output error occurs.	UILoader
keyDown	Dispatched when the user presses a key.	InteractiveObject
keyFocusChange	Dispatched when the user attempts to change focus by using keyboard navigation.	InteractiveObject
keyUp	Dispatched when the user releases a key.	InteractiveObject
middleClick	Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.	InteractiveObject
middleMouseDown	Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.	InteractiveObject
middleMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseFocusChange	Dispatched when the user attempts to change focus by using a pointer device.	InteractiveObject
mouseMove	Dispatched when a user moves the pointing device while it is over an InteractiveObject.	InteractiveObject
mouseOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
mouseOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
mouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseWheel	Dispatched when a mouse wheel is spun over an InteractiveObject instance.	InteractiveObject
move	Dispatched after the component is moved.	UIComponent
nativeDragComplete	Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.	InteractiveObject
nativeDragDrop	Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().	InteractiveObject
nativeDragEnter	Dispatched by an InteractiveObject when a drag gesture enters its boundary.	InteractiveObject
nativeDragExit	Dispatched by an InteractiveObject when a drag gesture leaves its boundary.	InteractiveObject
nativeDragOver	Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary.	InteractiveObject
nativeDragStart	Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
nativeDragUpdate	Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
open	Dispatched after a network operation starts.	UILoader
progress	Dispatched when content is loading.	UILoader
removed	Dispatched when a display object is about to be removed from the display list.	DisplayObject
removedFromStage	Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.	DisplayObject
render	Dispatched when the display list is about to be updated and rendered.	DisplayObject
resize	Dispatched after the component is resized.	UILoader
rightClick	Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.	InteractiveObject
rightMouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
rightMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
rollOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
rollOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
securityError	Dispatched after a security error occurs while content is loading.	UILoader
show	Dispatched after the component visibility changes from invisible to visible.	UIComponent
tabChildrenChange	Dispatched when the value of the object's tabChildren flag changes.	InteractiveObject
tabEnabledChange	Dispatched when the object's tabEnabled flag changes.	InteractiveObject
tabIndexChange	Dispatched when the value of the object's tabIndex property changes.	InteractiveObject

Description	Defined By
disabledTextFormat	Type: flash.text.TextFormat The TextFormat object to use to render the component label when the button is disabled.	UIComponent
focusRectPadding	Type: Number Format: Length The padding that separates the outside boundaries of the component from the outside edges of the focus indicator, in pixels.	UIComponent
focusRectSkin	Type: Class The skin to be used to display focus indicators.	UIComponent
textFormat	Type: flash.text.TextFormat The TextFormat object to use to render the component label.	UIComponent

Property Detail

autoLoad

property

autoLoad:Boolean [read-write]

Language Version :

ActionScript 3.0

Runtime Versions :

AIR 1.0, Flash Player 9.0.28.0

Gets or sets a value that indicates whether the UILoader instance automatically loads the specified content. A value of true indicates that the UILoader automatically loads the content; a value of false indicates that content is not loaded until the load() method is called.

The default value is true.

Implementation
public function get autoLoad():Boolean
public function set autoLoad(value:Boolean):void

See also

load()
source

Example

The following example shows how setting the autoLoad property to false prevents the content from being loaded until the load() method is called:


import fl.containers.UILoader;
import fl.controls.Button;

var myUILoader:UILoader = new UILoader();
myUILoader.autoLoad = false;
myUILoader.scaleContent = false;
myUILoader.source = "http://www.helpexamples.com/flash/images/image1.jpg";
myUILoader.move(10, 40);
addChild(myUILoader);

var myButton:Button = new Button();
myButton.label = "Load image";
myButton.move(10, 10);
myButton.addEventListener(MouseEvent.CLICK, clickHandler);
addChild(myButton);

function clickHandler(event:MouseEvent):void {
    myUILoader.load();
}

bytesLoaded

property

bytesLoaded:uint [read-only]

Language Version :

ActionScript 3.0

Runtime Versions :

AIR 1.0, Flash Player 9.0.28.0

Gets the count of bytes of content that have been loaded. When this property equals the value of bytesTotal, all the bytes are loaded.

The default value is 0.

Implementation
public function get bytesLoaded():uint

See also

bytesTotal
percentLoaded

Example

The following example creates a UILoader component instance that displays a loaded image, and a ProgressBar and Label component instance which display the current download status of the image:


import fl.containers.UILoader;
import fl.controls.Label;
import fl.controls.ProgressBar;
import fl.controls.ProgressBarMode;

var url:String = "http://www.helpexamples.com/flash/images/image3.jpg";

var myLabel:Label = new Label();
myLabel.autoSize = TextFieldAutoSize.LEFT;
myLabel.text = "";
myLabel.move(10, 10);
addChild(myLabel);

var myProgressBar:ProgressBar = new ProgressBar();
myProgressBar.mode = ProgressBarMode.MANUAL;
myProgressBar.move(10, 30);
addChild(myProgressBar);

var myUILoader:UILoader = new UILoader();
myUILoader.load(new URLRequest(url));
myUILoader.addEventListener(ProgressEvent.PROGRESS, progressHandler);
myUILoader.addEventListener(Event.COMPLETE, completeHandler);
myUILoader.move(10, 35);
addChild(myUILoader);

function progressHandler(event:ProgressEvent):void {
    var uiLdr:UILoader = event.currentTarget as UILoader;
    var kbLoaded:String = Number(uiLdr.bytesLoaded / 1024).toFixed(1);
    var kbTotal:String = Number(uiLdr.bytesTotal / 1024).toFixed(1);
    myLabel.text = kbLoaded + " of " + kbTotal + " KB" + " (" + Math.round(uiLdr.percentLoaded) + "%)";
    myProgressBar.setProgress(event.bytesLoaded, event.bytesTotal);
}

function completeHandler(event:Event):void {
    myLabel.visible = false;
    myProgressBar.visible = false;
    myUILoader.removeEventListener(ProgressEvent.PROGRESS, progressHandler);
    myUILoader.removeEventListener(Event.COMPLETE, completeHandler);
}

bytesTotal

property

bytesTotal:uint [read-only]

Language Version :

ActionScript 3.0

Runtime Versions :

AIR 1.0, Flash Player 9.0.28.0

Gets the count of bytes of content to be loaded.

The default value is 0.

Implementation
public function get bytesTotal():uint

See also

bytesLoaded
percentLoaded

Example

The following example creates a UILoader component instance that displays a loaded image, and a ProgressBar and Label component instance which display the current download status of the image:


import fl.containers.UILoader;
import fl.controls.Label;
import fl.controls.ProgressBar;
import fl.controls.ProgressBarMode;

var url:String = "http://www.helpexamples.com/flash/images/image3.jpg";

var myLabel:Label = new Label();
myLabel.autoSize = TextFieldAutoSize.LEFT;
myLabel.text = "";
myLabel.move(10, 10);
addChild(myLabel);

var myProgressBar:ProgressBar = new ProgressBar();
myProgressBar.mode = ProgressBarMode.MANUAL;
myProgressBar.move(10, 30);
addChild(myProgressBar);

var myUILoader:UILoader = new UILoader();
myUILoader.load(new URLRequest(url));
myUILoader.addEventListener(ProgressEvent.PROGRESS, progressHandler);
myUILoader.addEventListener(Event.COMPLETE, completeHandler);
myUILoader.move(10, 35);
addChild(myUILoader);

function progressHandler(event:ProgressEvent):void {
    var uiLdr:UILoader = event.currentTarget as UILoader;
    var kbLoaded:String = Number(uiLdr.bytesLoaded / 1024).toFixed(1);
    var kbTotal:String = Number(uiLdr.bytesTotal / 1024).toFixed(1);
    myLabel.text = kbLoaded + " of " + kbTotal + " KB" + " (" + Math.round(uiLdr.percentLoaded) + "%)";
    myProgressBar.setProgress(event.bytesLoaded, event.bytesTotal);
}

function completeHandler(event:Event):void {
    myLabel.visible = false;
    myProgressBar.