+Show TOC
×Hide TOC

LoaderEvent

Kind of class:	public class
Package:	com.bourre.load
Inherits from:	BasicEvent < Event
Known subclasses:	ApplicationLoaderEvent ContextLoaderEvent DisplayObjectBuilderEvent FileLoaderEvent GraphicLoaderEvent QueueLoaderEvent RemotingCallEvent SoundLoaderEvent VideoDisplayEvent XMLLoaderEvent
Version:	1.0
Author:	Francis Bourre
Classpath:	com.bourre.load.LoaderEvent
File last modified:	Monday, 24 November 2008, 11:36:47

► View source

▼ Hide source

/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (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.mozilla.org/MPL/MPL-1.1.html
 * 
 * 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.
 */
package com.bourre.load
{
    import com.bourre.events.BasicEvent;    
    
    /**
     * @author Francis Bourre
     * @version 1.0
     */
    public class LoaderEvent 
        extends BasicEvent
    {
        public static const onLoadStartEVENT     : String = "onLoadStart";
        public static const onLoadInitEVENT     : String = "onLoadInit";
        public static const onLoadProgressEVENT : String = "onLoadProgress";
        public static const onLoadTimeOutEVENT     : String = "onLoadTimeOut";
        public static const onLoadErrorEVENT     : String = "onLoadError";
        
        protected var _loader : Loader;
        protected var _sErrorMessage : String;
        
        public function LoaderEvent( type : String, loader : Loader, errorMessage : String = "" )
        {
            super( type, loader );
            _loader = loader;
            _sErrorMessage = errorMessage;
        }

        public function getLoader() : Loader
        {
            return _loader;
        }
        
        public function getPerCent() : Number
        {
            return getLoader().getPerCent();
        }
        
        public function getName() : String
        {
            return getLoader().getName();
        }
        
        public function setErrorMessage( errorMessage : String = "" ) : void
        {
            _sErrorMessage = errorMessage.length > 0 ? errorMessage : getLoader() + " loading fails with '" + getLoader().getURL().url + "'";
        }
        
        public function getErrorMessage() : String
        {
            return _sErrorMessage;
        }
    }
}

Summary

Constructor

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

Instance properties

Instance properties inherited from BasicEvent

_oTarget _sType target type

Instance methods

getLoader : Loader
getPerCent : Number
getName : String
setErrorMessage (errorMessage:String = "") : void
getErrorMessage : String

Instance methods inherited from BasicEvent

clone getTarget getType setTarget setType toString

Event handlers

onLoadStartEVENT : String
onLoadInitEVENT : String
onLoadProgressEVENT : String
onLoadTimeOutEVENT : String
onLoadErrorEVENT : String

Constructor

LoaderEvent

public function LoaderEvent (

type:String, loader:Loader, errorMessage:String = "")

Instance methods

getErrorMessage

public function getErrorMessage (

) : String

getLoader

public function getLoader (

) : Loader

getName

public function getName (

) : String

getPerCent

public function getPerCent (

) : Number

setErrorMessage

public function setErrorMessage (

errorMessage:String = "") : void

Event handlers

onLoadErrorEVENT

public static const onLoadErrorEVENT:String = "onLoadError"

(read)

onLoadInitEVENT

public static const onLoadInitEVENT:String = "onLoadInit"

(read)

onLoadProgressEVENT

public static const onLoadProgressEVENT:String = "onLoadProgress"

(read)

onLoadStartEVENT

public static const onLoadStartEVENT:String = "onLoadStart"

(read)

onLoadTimeOutEVENT

public static const onLoadTimeOutEVENT:String = "onLoadTimeOut"

(read)