Loader class

Inheritance MovieClip > UIObject class > UIComponent class > View > Loader

ActionScript Class Name mx.controls.Loader

The properties of the Loader class let you set content to load and monitor its loading progress at runtime.

Setting a property of the Loader class with ActionScript overrides the parameter of the same name set in the Property inspector or Component inspector.

Each component class has a version property, which is a class property. Class properties are available only on the class itself. The version property returns a string that indicates the version of the component. To access this property, use the following code:

trace(mx.controls.Loader.version);

NOTE

The code trace(myLoaderInstance.version); returns undefined.

Method summary for the Loader class

The following table lists the method of the Loader class.

Method	Description
Loader.load()	Loads the content specified by the `contentPath` property.

Methods inherited from the UIObject class

The following table lists the methods the Loader class inherits from the UIObject class. When calling these methods from the Loader object, use the form LoaderInstance.methodName.

Method	Description
UIObject.createClassObject()	Creates an object on the specified class.
UIObject.createObject()	Creates a subobject on an object.
UIObject.destroyObject()	Destroys a component instance.
UIObject.doLater()	Calls a function when parameters have been set in the Property and Component inspectors.
UIObject.getStyle()	Gets the style property from the style declaration or object.
UIObject.invalidate()	Marks the object so it is redrawn on the next frame interval.
UIObject.move()	Moves the object to the requested position.
UIObject.redraw()	Forces validation of the object so it is drawn in the current frame.
UIObject.setSize()	Resizes the object to the requested size.
UIObject.setSkin()	Sets a skin in the object.
UIObject.setStyle()	Sets the style property on the style declaration or object.

Methods inherited from the UIComponent class

The following table lists the methods the Loader class inherits from the UIComponent class. When calling these methods from the Loader object, use the form LoaderInstance.methodName.

Method	Description
UIComponent.getFocus()	Returns a reference to the object that has focus.
UIComponent.setFocus()	Sets focus to the component instance.

Property summary for the Loader class

The following table lists properties of the Loader class.

Property	Description
Loader.autoLoad	A Boolean value that indicates whether the content loads automatically (`true`) or you must call Loader.load() (`false`).
Loader.bytesLoaded	A read-only property that indicates the number of bytes that have been loaded.
Loader.bytesTotal	A read-only property that indicates the total number of bytes in the content.
Loader.content	A reference to the content of the loader. This property is read-only.
Loader.contentPath	A string that indicates the URL of the content to be loaded.
Loader.percentLoaded	A number that indicates the percentage of loaded content. This property is read-only.
Loader.scaleContent	A Boolean value that indicates whether the content scales to fit the loader (`true`), or the loader scales to fit the content (`false`).

Properties inherited from the UIObject class

The following table lists the properties the Loader class inherits from the UIObject class. When accessing these properties from the Loader object, use the form LoaderInstance.propertyName.

Property	Description
UIObject.bottom	The position of the bottom edge of the object, relative to the bottom edge of its parent. Read-only.
UIObject.height	The height of the object, in pixels. Read-only.
UIObject.left	The left edge of the object, in pixels. Read-only.
UIObject.right	The position of the right edge of the object, relative to the right edge of its parent. Read-only.
UIObject.scaleX	A number indicating the scaling factor in the x direction of the object, relative to its parent.
UIObject.scaleY	A number indicating the scaling factor in the y direction of the object, relative to its parent.
UIObject.top	The position of the top edge of the object, relative to its parent. Read-only.
UIObject.visible	A Boolean value indicating whether the object is visible (`true`) or not (`false`).
UIObject.width	The width of the object, in pixels. Read-only.
UIObject.x	The left edge of the object, in pixels. Read-only.
UIObject.y	The top edge of the object, in pixels. Read-only.

Properties inherited from the UIComponent class

The following table lists the properties the Loader class inherits from the UIComponent class. When accessing these properties from the Loader object, use the form LoaderInstance.propertyName.

Property	Description
UIComponent.enabled	Indicates whether the component can receive focus and input.
UIComponent.tabIndex	A number indicating the tab order for a component in a document.

Event summary for the Loader class

The following table lists events of the Loader class.

Event	Description
Loader.complete	Triggered when the content finished loading.
Loader.progress	Triggered while content is loading.

Events inherited from the UIObject class

The following table lists the events the Loader class inherits from the UIObject class.

Event	Description
UIObject.draw	Broadcast when an object is about to draw its graphics.
UIObject.hide	Broadcast when an object's state changes from visible to invisible.
UIObject.load	Broadcast when subobjects are being created.
UIObject.move	Broadcast when the object has moved.
UIObject.resize	Broadcast when an object has been resized.
UIObject.reveal	Broadcast when an object's state changes from invisible to visible.
UIObject.unload	Broadcast when the subobjects are being unloaded.

Events inherited from the UIComponent class

The following table lists the events the Loader class inherits from the UIComponent class.

Event	Description
UIComponent.focusIn	Broadcast when an object receives focus.
UIComponent.focusOut	Broadcast when an object loses focus.
UIComponent.keyDown	Broadcast when a key is pressed.
UIComponent.keyUp	Broadcast when a key is released.

Version 8

Comments

No screen name said on Mar 22, 2007 at 9:16 AM :

loader "percentLoaded" property does not reset when changing the "contentPath".

RSS feed | Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flash/8/main/00003744.html