+Show TOC
×Hide TOC

GraphicLoad

Kind of class:	public class
Package:	org.casalib.load
Inherits from:	LoadItem < BaseLoadItem < Process < RemovableEventDispatcher < EventDispatcher
Version:	11/02/08
Author:	Aaron Clinger
Classpath:	org.casalib.load.GraphicLoad
File last modified:	Monday, 01 December 2008, 11:16:36

► View source

▼ Hide source

/*
    CASA Lib for ActionScript 3.0
    Copyright (c) 2008, Aaron Clinger & Contributors of CASA Lib
    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 Lib 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.Bitmap;
    import flash.display.BitmapData;
    import flash.display.DisplayObject;
    import flash.display.Loader;
    import flash.display.LoaderInfo;
    import flash.display.MovieClip;
    import flash.events.Event;
    import flash.events.IEventDispatcher;
    import flash.events.HTTPStatusEvent;
    import flash.events.SecurityErrorEvent;
    import flash.system.LoaderContext;
    import org.casalib.load.LoadItem;
    
    [Event(name="init", type="flash.events.Event")]
    [Event(name="open", 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")]
    
    /**
        Provides an easy and standardized way to load images or SWF files.
        
        @author Aaron Clinger
        @version 11/02/08
        @example
            <code>
                package {
                    import flash.display.MovieClip;
                    import org.casalib.events.LoadEvent;
                    import org.casalib.load.GraphicLoad;
                    
                    
                    public class MyExample extends MovieClip {
                        protected var _graphicLoad:GraphicLoad;
                        
                        
                        public function MyExample() {
                            super();
                            
                            this._graphicLoad = new GraphicLoad("test.jpg");
                            this._graphicLoad.addEventListener(LoadEvent.COMPLETE, this._onComplete);
                            this._graphicLoad.start();
                        }
                        
                        protected function _onComplete(e:LoadEvent):void {
                            this.addChild(this._graphicLoad.loader);
                        }
                    }
                }
            </code>
    */
    public class GraphicLoad extends LoadItem {
        protected var _context:LoaderContext;
        
        
        /**
            Creates and defines a GraphicLoad.
            
            @param request: A {@code String} or an {@code URLRequest} reference to the file you wish to load.
            @param context: An optional LoaderContext object.
        */
        public function GraphicLoad(request:*, context:LoaderContext = null) {
            super(new Loader(), request);
            
            this._context = context;
            
            this._initListeners(this._loadItem.contentLoaderInfo);
        }
        
        /**
            The Loader being used to load the image or SWF.
        */
        public function get loader():Loader {
            return this._loadItem as Loader;
        }
        
        /**
            The LoaderInfo corresponding to the object being loaded.
        */
        public function get loaderInfo():LoaderInfo {
            return this._loadItem.contentLoaderInfo;
        }
        
        /**
            The content received from the GraphicLoad. Available after load is complete.
        */
        public function get content():DisplayObject {
            return this._loadItem.content;
        }
        
        /**
            The data received from the DataLoad data typed as MovieClip. Available after load is complete.
        */
        public function get contentAsMovieClip():MovieClip {
            if (!this.loaded || this.loaderInfo.contentType != 'application/x-shockwave-flash')
                return null;
            
            return this.content as MovieClip;
        }
        
        /**
            The data received from the DataLoad data typed as Bitmap. Available after load is complete.
        */
        public function get contentAsBitmap():Bitmap {
            if (!this.loaded || this.loaderInfo.contentType == 'application/x-shockwave-flash')
                return null;
            
            return this.content as Bitmap;
        }
        
        /**
            The data received from the DataLoad data typed as BitmapData. Available after load is complete.
        */
        public function get contentAsBitmapData():BitmapData {
            if (!this.loaded || this.loaderInfo.contentType == 'application/x-shockwave-flash')
                return null;
            
            return this.contentAsBitmap.bitmapData;
        }
        
        /**
            The total number of bytes of the requested file.
        */
        override public function get bytesTotal():uint {
            return 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, false);
            this._dispatcher.removeEventListener(Event.OPEN, this.dispatchEvent, false);
            this._dispatcher.removeEventListener(Event.UNLOAD, this.dispatchEvent, false);
            this._dispatcher.removeEventListener(HTTPStatusEvent.HTTP_STATUS, this.dispatchEvent, false);
            this._dispatcher.removeEventListener(SecurityErrorEvent.SECURITY_ERROR, this.dispatchEvent, false);
            
            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#OPEN - Dispatched when a load operation starts.
            @sends Event#UNLOAD - Dispatched when {@code unload} 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.OPEN, this.dispatchEvent, false, 0, true);
            this._dispatcher.addEventListener(Event.UNLOAD, this.dispatchEvent, false, 0, true);
            this._dispatcher.addEventListener(HTTPStatusEvent.HTTP_STATUS, this.dispatchEvent, false, 0, true);
            this._dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, this.dispatchEvent, false, 0, true);
        }
    }
}

Provides an easy and standardized way to load images or SWF files.

Example:

package {
    import flash.display.MovieClip;
    import org.casalib.events.LoadEvent;
    import org.casalib.load.GraphicLoad;


    public class MyExample extends MovieClip {
        protected var _graphicLoad:GraphicLoad;


        public function MyExample() {
            super();

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

        protected function _onComplete(e:LoadEvent):void {
            this.addChild(this._graphicLoad.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: OPEN - Dispatched when a load operation starts.
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

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

Class properties

Class properties inherited from Process

NORM_PRIORITY

Instance properties

loader : Loader
- The Loader being used to load the image or SWF.
loaderInfo : LoaderInfo
- The LoaderInfo corresponding to the object being loaded.
content : DisplayObject
- The content received from the GraphicLoad.
contentAsMovieClip : MovieClip
- The data received from the DataLoad data typed as MovieClip.
contentAsBitmap : Bitmap
- The data received from the DataLoad data typed as Bitmap.
contentAsBitmapData : BitmapData
- The data received from the DataLoad data typed as BitmapData.
bytesTotal : uint
- The total number of bytes of the requested file.
bytesLoaded : uint
- The number of bytes loaded of the requested file.

Instance properties inherited from LoadItem

Instance properties inherited from BaseLoadItem

Bps loaded loading preventCache progress

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 _initListeners _load _onComplete _onLoadError _onProgress destroy start stop

Instance methods inherited from BaseLoadItem

destroy start stop

Instance methods inherited from Process

_complete destroy start stop

Instance methods inherited from RemovableEventDispatcher

addEventListener destroy removeEventListener removeEventListeners removeEventsForListener removeEventsForType

Constructor

GraphicLoad

public function GraphicLoad (

request:*, context:LoaderContext = null)

Creates and defines a GraphicLoad.

Parameters:

request:

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

context:

An optional LoaderContext object.

Instance properties

bytesLoaded

override public bytesLoaded:uint

(read)

The number of bytes loaded of the requested file.

bytesTotal

override public bytesTotal:uint

(read)

The total number of bytes of the requested file.

content

public content:DisplayObject

(read)

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

contentAsBitmap

public contentAsBitmap:Bitmap

(read)

The data received from the DataLoad data typed as Bitmap. Available after load is complete.

contentAsBitmapData

public contentAsBitmapData:BitmapData

(read)

The data received from the DataLoad data typed as BitmapData. Available after load is complete.

contentAsMovieClip

public contentAsMovieClip:MovieClip

(read)

The data received from the DataLoad data typed as MovieClip. Available after load is complete.

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