+Show TOC
×Hide TOC

CasaLoader

Kind of class:	public class
Package:	org.casalib.load
Inherits from:	LoadItem < Process < RemovableEventDispatcher < EventDispatcher
Known subclasses:	ImageLoad SwfLoad
Version:	09/06/09
Author:	Aaron Clinger
Classpath:	org.casalib.load.CasaLoader
File last modified:	Sunday, 06 September 2009, 08:46:40

► View source

▼ Hide source

/*
    CASA Framework for ActionScript 3.0
    Copyright (c) 2009, Contributors of CASA Framework
    All rights reserved.
    
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
    
    - Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    
    - Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    
    - Neither the name of the CASA Framework nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.
    
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.
*/
package org.casalib.load {
    import flash.display.DisplayObject;
    import flash.display.Loader;
    import flash.display.LoaderInfo;
    import flash.events.Event;
    import flash.events.HTTPStatusEvent;
    import flash.events.IEventDispatcher;
    import flash.events.SecurityErrorEvent;
    import flash.system.LoaderContext;
    import org.casalib.load.LoadItem;
    
    [Event(name="init", type="flash.events.Event")]
    [Event(name="unload", type="flash.events.Event")]
    [Event(name="httpStatus", type="flash.events.HTTPStatusEvent")]
    [Event(name="securityError", type="flash.events.SecurityErrorEvent")]
    
    /**
        Wraps <code>Loader</code> and extends from {@link LoadItem} and {@link Process}.
        
        In almost all cases you will want to use {@link ImageLoad} or {@link SwfLoad} instead of this class.
        
        @author Aaron Clinger
        @version 09/06/09
        @example
            <code>
                package {
                    import org.casalib.display.CasaMovieClip;
                    import org.casalib.events.LoadEvent;
                    import org.casalib.load.CasaLoader;
                    
                    
                    public class MyExample extends CasaMovieClip {
                        protected var _casaLoader:CasaLoader;
                        
                        
                        public function MyExample() {
                            super();
                            
                            this._casaLoader = new CasaLoader("test.jpg");
                            this._casaLoader.addEventListener(LoadEvent.COMPLETE, this._onComplete);
                            this._casaLoader.start();
                        }
                        
                        protected function _onComplete(e:LoadEvent):void {
                            this.addChild(this._casaLoader.loader);
                        }
                    }
                }
            </code>
    */
    public class CasaLoader extends LoadItem {
        public static const FLASH_CONTENT_TYPE:String = 'application/x-shockwave-flash';
        public static const JPEG_CONTENT_TYPE:String  = 'image/jpeg';
        public static const GIF_CONTENT_TYPE:String   = 'image/gif';
        public static const PNG_CONTENT_TYPE:String   = 'image/png';
        protected var _context:LoaderContext;
        
        
        /**
            Creates and defines a CasaLoader.
            
            @param request: A <code>String</code> or an <code>URLRequest</code> reference to the file you wish to load.
            @param context: An optional LoaderContext object.
        */
        public function CasaLoader(request:*, context:LoaderContext = null) {
            super(new Loader(), request);
            
            this._context = context;
            
            this._initListeners(this.loaderInfo);
        }
        
        /**
            The Loader being used to load the image or SWF.
        */
        public function get loader():Loader {
            return this._loadItem as Loader;
        }
        
        /**
            The content received from the CasaLoader. Available after load is complete.
            
            @throws Error if method is called before the SWF has loaded.
        */
        public function get content():DisplayObject {
            if (!this.loaded)
                throw new Error('Cannot access an external asset until the SWF has loaded.');
            
            return this.loader.content;
        }
        
        /**
            The LoaderInfo corresponding to the object being loaded.
        */
        public function get loaderInfo():LoaderInfo {
            return this._loadItem.contentLoaderInfo;
        }
        
        /**
            @exclude
        */
        override public function get bytesTotal():Number {
            return (this._loadItem.contentLoaderInfo.bytesTotal == 0 && this.bytesLoaded != 0) ? Number.POSITIVE_INFINITY : this._loadItem.contentLoaderInfo.bytesTotal;
        }
        
        /**
            The number of bytes loaded of the requested file.
        */
        override public function get bytesLoaded():uint {
            return this._loadItem.contentLoaderInfo.bytesLoaded;
        }
        
        override public function destroy():void {
            this._dispatcher.removeEventListener(Event.INIT, this.dispatchEvent);
            this._dispatcher.removeEventListener(Event.UNLOAD, this.dispatchEvent);
            this._dispatcher.removeEventListener(HTTPStatusEvent.HTTP_STATUS, this._onHttpStatus);
            this._dispatcher.removeEventListener(SecurityErrorEvent.SECURITY_ERROR, this.dispatchEvent);
            
            super.destroy();
        }
        
        override protected function _load():void {
            this._loadItem.load(this._request, this._context);
        }
        
        /**
            @sends Event#INIT - Dispatched when the properties and methods of a loaded SWF file are accessible.
            @sends Event#UNLOAD - Dispatched when <code>unload</code> is called.
            @sends HTTPStatusEvent#HTTP_STATUS - Dispatched if class is able to detect and return the status code for the request.
            @sends SecurityErrorEvent#SECURITY_ERROR - Dispatched if load is outside the security sandbox.
        */
        override protected function _initListeners(dispatcher:IEventDispatcher):void {
            super._initListeners(dispatcher);
            
            this._dispatcher.addEventListener(Event.INIT, this.dispatchEvent, false, 0, true);
            this._dispatcher.addEventListener(Event.UNLOAD, this.dispatchEvent, false, 0, true);
            this._dispatcher.addEventListener(HTTPStatusEvent.HTTP_STATUS, this._onHttpStatus, false, 0, true);
            this._dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, this.dispatchEvent, false, 0, true);
        }
    }
}

Wraps Loader and extends from LoadItem and Process.

In almost all cases you will want to use ImageLoad or SwfLoad instead of this class.

Example:

package {
    import org.casalib.display.CasaMovieClip;
    import org.casalib.events.LoadEvent;
    import org.casalib.load.CasaLoader;


    public class MyExample extends CasaMovieClip {
        protected var _casaLoader:CasaLoader;


        public function MyExample() {
            super();

            this._casaLoader = new CasaLoader("test.jpg");
            this._casaLoader.addEventListener(LoadEvent.COMPLETE, this._onComplete);
            this._casaLoader.start();
        }

        protected function _onComplete(e:LoadEvent):void {
            this.addChild(this._casaLoader.loader);
        }
    }
}

Events broadcasted to listeners:

Event with type: INIT - Dispatched when the properties and methods of a loaded SWF file are accessible.
Event with type: UNLOAD - Dispatched when unload is called.
HTTPStatusEvent with type: HTTP_STATUS - Dispatched if class is able to detect and return the status code for the request.
SecurityErrorEvent with type: SECURITY_ERROR - Dispatched if load is outside the security sandbox.

Summary

Constructor

CasaLoader (request:*, context:LoaderContext = null)
- Creates and defines a CasaLoader.

Constants

FLASH_CONTENT_TYPE : String
JPEG_CONTENT_TYPE : String
GIF_CONTENT_TYPE : String
PNG_CONTENT_TYPE : String

Class properties

Class properties inherited from Process

NORM_PRIORITY

Instance properties

loader : Loader
- The Loader being used to load the image or SWF.
content : DisplayObject
- The content received from the CasaLoader.
loaderInfo : LoaderInfo
- The LoaderInfo corresponding to the object being loaded.
bytesLoaded : uint
- The number of bytes loaded of the requested file.

Instance properties inherited from LoadItem

Instance properties inherited from Process

_hasCompleted _isRunning _priority completed priority running

Instance properties inherited from RemovableEventDispatcher

_isDestroyed _listenerManager destroyed

Instance methods

destroy : void

Instance methods inherited from LoadItem

_calculateLoadProgress _complete _createDefinedLoadEvent _createRequest _initListeners _load _onComplete _onHttpStatus _onLoadError _onOpen _onProgress destroy start stop

Instance methods inherited from Process

_complete destroy start stop

Instance methods inherited from RemovableEventDispatcher

addEventListener destroy dispatchEvent removeEventListener removeEventListeners removeEventsForListener removeEventsForType

Constructor

CasaLoader

public function CasaLoader (

request:*, context:LoaderContext = null)

Creates and defines a CasaLoader.

Parameters:

request:

A String or an URLRequest reference to the file you wish to load.

context:

An optional LoaderContext object.

Constants

FLASH_CONTENT_TYPE

public static const FLASH_CONTENT_TYPE:String = 'application/x-shockwave-flash'

(read)

GIF_CONTENT_TYPE

public static const GIF_CONTENT_TYPE:String = 'image/gif'

(read)

JPEG_CONTENT_TYPE

public static const JPEG_CONTENT_TYPE:String = 'image/jpeg'

(read)

PNG_CONTENT_TYPE

public static const PNG_CONTENT_TYPE:String = 'image/png'

(read)

Instance properties

bytesLoaded

override public bytesLoaded:uint

(read)

The number of bytes loaded of the requested file.

content

public content:DisplayObject

(read)

The content received from the CasaLoader. Available after load is complete.

Throws:

Error if method is called before the SWF has loaded.

loader

public loader:Loader

(read)

The Loader being used to load the image or SWF.

loaderInfo

public loaderInfo:LoaderInfo

(read)

The LoaderInfo corresponding to the object being loaded.

Instance methods

destroy

override public function destroy (

) : void

Overrides:

LoadItem.destroy