com.bourre.load.LoaderEvent

	Property	Defined by
		target : Object The source object of this event	BasicEvent
		type : String The type of this event	BasicEvent

	Property	Defined by
		_oTarget : Object The source object of this event, redefined to provide write access	BasicEvent
		_sType : String The type of the event, redefined to provide write access	BasicEvent

	Method	Defined by
		LoaderEvent(type:String, loader:Loader, errorMessage:String = "") Creates a new `LoaderEvent` object.	LoaderEvent
		clone():Event Clone the event	BasicEvent
		getErrorMessage():String Returns the error message carried by this event.	LoaderEvent
		getLoader():Loader Returns the loader object carried by this event.	LoaderEvent
		getName():String Returns the loader named carried by this event.	LoaderEvent
		getPerCent():Number Returns the loading progression value of object carried by this event.	LoaderEvent
		getTarget():Object Returns the current source of this event object.	BasicEvent
		getType():String Returns the type of this event, which generally correspond to the name of the called function on the listener.	BasicEvent
		setErrorMessage(errorMessage:String = ""):void Sets the error message to be carried by this event.	LoaderEvent
		setTarget(oTarget:Object):void Defines the new source object of this event.	BasicEvent
		setType(en:String):void Defines the new event type for this event object.	BasicEvent
		toString():String Returns the string representation of this instance.	BasicEvent

	Constant	Defined by
		onLoadErrorEVENT : String = "onLoadError" [static] Defines the value of the `type` property of the event object for a `onLoadError` event.	LoaderEvent
		onLoadInitEVENT : String = "onLoadInit" [static] Defines the value of the `type` property of the event object for a `onLoadInit` event.	LoaderEvent
		onLoadProgressEVENT : String = "onLoadProgress" [static] Defines the value of the `type` property of the event object for a `onLoadProgress` event.	LoaderEvent
		onLoadStartEVENT : String = "onLoadStart" [static] Defines the value of the `type` property of the event object for a `onLoadStart` event.	LoaderEvent
		onLoadTimeOutEVENT : String = "onLoadTimeOut" [static] Defines the value of the `type` property of the event object for a `onLoadTimeOut` event.	LoaderEvent

Constructor detail

LoaderEvent

()

constructor

public function LoaderEvent(type:String, loader:Loader, errorMessage:String = "")

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Creates a new LoaderEvent object.

Parameters

	`type:String` — Name of the event type

	`loader:Loader` — Loader object carried by this event

	`errorMessage:String` (default = "") — (optional) Error message carried by this event

Method detail

getErrorMessage

()

method

public function getErrorMessage():String

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns the error message carried by this event.

Returns

String — The error message carried by this event.

getLoader

()

method

public function getLoader():Loader

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns the loader object carried by this event.

Returns

Loader — The loader value carried by this event.

getName

()

method

public function getName():String

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns the loader named carried by this event.

Returns

String — The loader name carried by this event.

getPerCent

()

method

public function getPerCent():Number

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Returns the loading progression value of object carried by this event.

Returns

Number — The loading progression value of object carried by this event.

setErrorMessage

()

method

public function setErrorMessage(errorMessage:String = ""):void

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Sets the error message to be carried by this event.

Parameters

errorMessage:String (default = "") — Error message to carry

Constant detail

onLoadErrorEVENT

constant

public static const onLoadErrorEVENT:String = "onLoadError"

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Defines the value of the type property of the event object for a onLoadError event.

The properties of the event object have the following values:

Property	Value
`type`	Dispatched event type
Method	Value
`getLoader()`	The loader object
`getName()`	The loader identifier
`getErrorMessage()`	The loader identifier

onLoadInitEVENT

constant

public static const onLoadInitEVENT:String = "onLoadInit"

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Defines the value of the type property of the event object for a onLoadInit event.

The properties of the event object have the following values:

Property	Value
`type`	Dispatched event type
Method	Value
`getLoader()`	The loader object
`getName()`	The loader identifier

onLoadProgressEVENT

constant

public static const onLoadProgressEVENT:String = "onLoadProgress"

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Defines the value of the type property of the event object for a onLoadProgress event.

The properties of the event object have the following values:

Property	Value
`type`	Dispatched event type
Method	Value
`getLoader()`	The loader object
`getName()`	The loader identifier
`getPercent()`	The loading progression

onLoadStartEVENT

constant

public static const onLoadStartEVENT:String = "onLoadStart"

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Defines the value of the type property of the event object for a onLoadStart event.

The properties of the event object have the following values:

Property	Value
`type`	Dispatched event type
Method	Value
`getLoader()`	The loader object
`getName()`	The loader identifier

onLoadTimeOutEVENT

constant

public static const onLoadTimeOutEVENT:String = "onLoadTimeOut"

Player version:	Flash Player 9.0
Language version:	ActionScript 3.0

Defines the value of the type property of the event object for a onLoadTimeOut event.

The properties of the event object have the following values:

Property	Value
`type`	Dispatched event type
Method	Value
`getLoader()`	The loader object
`getName()`	The loader identifier

Submit Feedback

LowRA API documentation 2008- 2009
Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1
mer. févr. 25 2009, 9:22 AM GMT+01:00

LowRA API Documentation	Annexes \| All Packages \| All Classes \| Index \| Frames No Frames
Class LoaderEvent	Properties \| Methods \| Constants

Package	com.bourre.load
Class	public class LoaderEvent
Inheritance	LoaderEvent BasicEvent flash.events.Event
Subclasses	ApplicationLoaderEvent, ContextLoaderEvent, DisplayObjectBuilderEvent, FileLoaderEvent, GraphicLoaderEvent, QueueLoaderEvent, RemotingCallEvent, SoundLoaderEvent, StreamLoaderEvent, VideoDisplayEvent, XMLLoaderEvent