+Show TOC
×Hide TOC

BaseLoadItem

Kind of class:	public class
Package:	org.casalib.load
Inherits from:	Process < RemovableEventDispatcher < EventDispatcher
Known subclasses:	LoadItem
Version:	10/29/08
Author:	Aaron Clinger
Classpath:	org.casalib.load.BaseLoadItem
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 org.casalib.math.Percent;
    import org.casalib.process.Process;
    
    /**
        Base class used by load classes. BaseLoadItem is not designed to be used on its own and needs to be extended to function.
        
        @author Aaron Clinger
        @version 10/29/08
    */
    public class BaseLoadItem extends Process {
        
        
        /**
            Creates a new BaseLoadItem.
        */
        public function BaseLoadItem() {
            super();
        }
        
        /**
            Begins the loading process.
        */
        override public function start():void {
            super.start();
        }
        
        /**
            Cancels the currently loading file from completing.
        */
        override public function stop():void {
            super.stop();
        }
        
        /**
            The current download speed of the requested file in bytes per second.
        */
        public function get Bps():int {
            return -1;
        }
        
        /**
            Determines if the requested file has loaded {@code true}, or hasn't finished loading {@code false}.
        */
        public function get loaded():Boolean {
            return false;
        }
        
        /**
            Determines if the requested file is loading {@code true}, or if it isn't currently loading {@code false}.
        */
        public function get loading():Boolean {
            return this.running;
        }
        
        /**
            Specifies if a random value name/value pair should be appended to the query string to help prevent caching {@code true}, or not append {@code false}; defaults to {@code false}.
        */
        public function get preventCache():Boolean {
            return false;
        }
        
        public function set preventCache(cache:Boolean):void {}
        
        /**
            The percent that the requested file has loaded.
        */
        public function get progress():Percent {
            return new Percent();
        }
        
        override public function destroy():void {
            super.destroy();
        }
    }
}

Base class used by load classes. BaseLoadItem is not designed to be used on its own and needs to be extended to function.

Summary

Constructor

BaseLoadItem

Class properties

Class properties inherited from Process

NORM_PRIORITY

Instance properties

Bps : int
- The current download speed of the requested file in bytes per second.
loaded : Boolean
- Determines if the requested file has loaded true, or hasn't finished loading false.
loading : Boolean
- Determines if the requested file is loading true, or if it isn't currently loading false.
preventCache : Boolean
- Specifies if a random value name/value pair should be appended to the query string to help prevent caching true, or not append false; defaults to false.
progress : Percent
- The percent that the requested file has loaded.

Instance properties inherited from Process

_hasCompleted _isRunning _priority completed priority running

Instance properties inherited from RemovableEventDispatcher

_isDestroyed _listenerManager destroyed

Instance methods

start : void
- Begins the loading process.
stop : void
- Cancels the currently loading file from completing.
destroy : void

Instance methods inherited from Process

_complete destroy start stop

Instance methods inherited from RemovableEventDispatcher

addEventListener destroy removeEventListener removeEventListeners removeEventsForListener removeEventsForType

Constructor

BaseLoadItem

public function BaseLoadItem (

)

Creates a new BaseLoadItem.

Instance properties

Bps

public Bps:int

(read)

The current download speed of the requested file in bytes per second.

loaded

public loaded:Boolean

(read)

Determines if the requested file has loaded true, or hasn't finished loading false.

loading

public loading:Boolean

(read)

Determines if the requested file is loading true, or if it isn't currently loading false.

preventCache

public preventCache:Boolean

(read,write)

Specifies if a random value name/value pair should be appended to the query string to help prevent caching true, or not append false; defaults to false.

progress

public progress:Percent

(read)

The percent that the requested file has loaded.

Instance methods

destroy

override public function destroy (

) : void

Overrides:

Process.destroy

start

override public function start (

) : void

Begins the loading process.

Overrides:

Process.start

stop

override public function stop (

) : void

Cancels the currently loading file from completing.

Overrides:

Process.stop