+Show TOC
×Hide TOC

LoadInterface

Kind of class:	interface
Inherits from:	RunnableInterface < CoreInterface
Implemented by:	Load LoadGroup
Known subinterfaces:	RetryableLoadInterface
Version:	12/18/06
Author:	Aaron Clinger
Classpath:	org.casalib.load.base.LoadInterface
File last modified:	Monday, 01 December 2008, 13:34:40

► View source

▼ Hide source

/*
    CASA Lib for ActionScript 2.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.
*/

import org.casalib.control.RunnableInterface;

/**
    @author Aaron Clinger
    @version 12/18/06
*/

interface org.casalib.load.base.LoadInterface extends RunnableInterface {
    
    /**
        Retrieves the path to the file that is to be loaded.
        
        @return String containing the path to the file.
    */
    public function getFilePath():String;
    
    /**
        Determines whether the requested file has finished loading.
        
        @return     Returns <code>true</code> if file has completely loaded; otherwise <code>false</code>.
    */
    public function hasLoaded():Boolean;
    
    /**
        Determines whether the requested file is in the process of loading.
        
        @return Returns <code>true</code> if the file is currently loading; otherwise <code>false</code>.
    */
    public function isLoading():Boolean;
}

Summary

Instance methods

getFilePath : String
- Retrieves the path to the file that is to be loaded.
hasLoaded : Boolean
- Determines whether the requested file has finished loading.
isLoading : Boolean
- Determines whether the requested file is in the process of loading.

Instance methods inherited from RunnableInterface

start stop

Instance methods inherited from CoreInterface

destroy toString

Instance methods

getFilePath

function getFilePath (

) : String

Retrieves the path to the file that is to be loaded.

Returns:

String containing the path to the file.

hasLoaded

function hasLoaded (

) : Boolean

Determines whether the requested file has finished loading.

Returns:

Returns true if file has completely loaded; otherwise false.

isLoading

function isLoading (

) : Boolean

Determines whether the requested file is in the process of loading.

Returns:

Returns true if the file is currently loading; otherwise false.