+Show TOC
×Hide TOC

ImageLoad

Kind of class:	public class
Package:	org.casalib.load
Inherits from:	CasaLoader < LoadItem < Process < RemovableEventDispatcher < EventDispatcher
Version:	02/13/10
Author:	Aaron Clinger
Classpath:	org.casalib.load.ImageLoad
File last modified:	Sunday, 28 March 2010, 11:55:55

► View source

▼ Hide source

/*
    CASA Lib for ActionScript 3.0
    Copyright (c) 2010, 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.system.LoaderContext;
    import org.casalib.load.CasaLoader;
    
    
    /**
        Provides an easy and standardized way to load images.
        
        @author Aaron Clinger
        @version 02/13/10
        @example
            <code>
                package {
                    import org.casalib.display.CasaMovieClip;
                    import org.casalib.events.LoadEvent;
                    import org.casalib.load.ImageLoad;
                    
                    
                    public class MyExample extends CasaMovieClip {
                        protected var _imageLoad:ImageLoad;
                        
                        
                        public function MyExample() {
                            super();
                            
                            this._imageLoad = new ImageLoad("test.jpg");
                            this._imageLoad.addEventListener(LoadEvent.COMPLETE, this._onComplete);
                            this._imageLoad.start();
                        }
                        
                        protected function _onComplete(e:LoadEvent):void {
                            this.addChild(this._imageLoad.contentAsBitmap);
                        }
                    }
                }
            </code>
    */
    public class ImageLoad extends CasaLoader {
        
        
        /**
            Creates and defines an ImageLoad.
            
            @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.
            @throws ArguementTypeError if you pass a type other than a <code>String</code> or an <code>URLRequest</code> to parameter <code>request</code>.
            @throws Error if you try to load an empty <code>String</code> or <code>URLRequest</code>.
        */
        public function ImageLoad(request:*, context:LoaderContext = null) {
            super(request, context);
        }
        
        /**
            The data received from the DataLoad data typed as Bitmap. Available after load is complete.
            
            @throws Error if method is called before the SWF has loaded.
            @throws Error if method cannot convert content to a Bitmap.
        */
        public function get contentAsBitmap():Bitmap {
            if (!this.loaded || this.loaderInfo.contentType == CasaLoader.FLASH_CONTENT_TYPE)
                throw new Error('Cannot convert content to a Bitmap.');
            
            return this.content as Bitmap;
        }
        
        /**
            The data received from the DataLoad data typed as BitmapData. Available after load is complete.
            
            @throws Error if method is called before the SWF has loaded.
            @throws Error if method cannot convert content to BitmapData.
        */
        public function get contentAsBitmapData():BitmapData {
            if (!this.loaded || this.loaderInfo.contentType == CasaLoader.FLASH_CONTENT_TYPE)
                throw new Error('Cannot convert content to BitmapData.');
            
            return this.contentAsBitmap.bitmapData;
        }
    }
}

Provides an easy and standardized way to load images.

Example:

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


    public class MyExample extends CasaMovieClip {
        protected var _imageLoad:ImageLoad;


        public function MyExample() {
            super();

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

        protected function _onComplete(e:LoadEvent):void {
            this.addChild(this._imageLoad.contentAsBitmap);
        }
    }
}

Summary

Constructor

ImageLoad (request:*, context:LoaderContext = null)
- Creates and defines an ImageLoad.

Constants

Constants inherited from CasaLoader

FLASH_CONTENT_TYPE GIF_CONTENT_TYPE JPEG_CONTENT_TYPE PNG_CONTENT_TYPE

Class properties

Class properties inherited from Process

NORM_PRIORITY

Instance properties

contentAsBitmap : Bitmap
- The data received from the DataLoad data typed as Bitmap.
contentAsBitmapData : BitmapData
- The data received from the DataLoad data typed as BitmapData.

Instance properties inherited from CasaLoader

_context bytesLoaded bytesTotal content loader loaderInfo

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

Instance methods inherited from CasaLoader

_initListeners _load destroy

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 getTotalEventListeners removeEventListener removeEventListeners removeEventsForListener removeEventsForType

Constructor

ImageLoad

public function ImageLoad (

request:*, context:LoaderContext = null)

Creates and defines an ImageLoad.

Parameters:

request:

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

context:

An optional LoaderContext object.

Throws:

ArguementTypeError if you pass a type other than a String or an URLRequest to parameter request.
Error if you try to load an empty String or URLRequest.

Instance properties

contentAsBitmap

public contentAsBitmap:Bitmap

(read)

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

Throws:

Error if method is called before the SWF has loaded.
Error if method cannot convert content to a Bitmap.

contentAsBitmapData

public contentAsBitmapData:BitmapData

(read)

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

Throws:

Error if method is called before the SWF has loaded.
Error if method cannot convert content to BitmapData.