Packagecom.soma.loader
Interfacepublic interface ILoading

Author: Romuald Quantin - www.soundstep.com
Project host: http://code.google.com/p/somaloader/
Class version: 1.0.2
Actionscript version: 3.0

Copyright:

The contents of this file are subject to the Mozilla Public License
Version 1.1 (the "License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.mozilla.org/MPL/

Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied.
See the License for the specific language governing rights and
limitations under the License.

The Original Code is SomaLoader.
The Initial Developer of the Original Code is Romuald Quantin.
Initial Developer are Copyright (C) 2008-2009 Soundstep. All Rights Reserved.

Date: 20 Feb 2009

Usage:
A loading DisplayObject can be inserted in a SomaLoader instance to show the progress of a loading.
The loading class must implement ILoading to be accepted by the SomaLoader instance.


Example 
  var loader:SomaLoader = new SomaLoader();
  var myLoading:MyLoading = new MyLoading();
  addChild(myLoading);
  loader.loading = myLoading;


Public Methods
 MethodDefined by
  
error(event:SomaLoaderEvent):void
Receives a SomaLoaderEvent.ERROR event when an Error is dispatched by the SomaLoader instance.
ILoading
  
itemComplete(event:SomaLoaderEvent):void
Receives a SomaLoaderEvent.COMPLETE event when a loading of an item is complete.
ILoading
  
itemProgress(event:SomaLoaderEvent):void
Receives a SomaLoaderEvent.PROGRESS event when a loading of an item progresses.
ILoading
  
itemStart(event:SomaLoaderEvent):void
Receives a SomaLoaderEvent.START event when a loading of an item starts.
ILoading
  
queueComplete():void
Receives a SomaLoaderEvent.QUEUE_COMPLETE event when the loading of a list of items is complete.
ILoading
  
queueProgress(event:SomaLoaderEvent):void
Receives a SomaLoaderEvent.QUEUE_PROGRESS event when the loading of a list of items progresses.
ILoading
  
queueStart():void
Receives a SomaLoaderEvent.QUEUE_START event when the loading of a list of items starts.
ILoading
Method detail
error()method
public function error(event:SomaLoaderEvent):void

Receives a SomaLoaderEvent.ERROR event when an Error is dispatched by the SomaLoader instance.

Parameters
event:SomaLoaderEvent
itemComplete()method 
public function itemComplete(event:SomaLoaderEvent):void

Receives a SomaLoaderEvent.COMPLETE event when a loading of an item is complete.

Parameters
event:SomaLoaderEvent
itemProgress()method 
public function itemProgress(event:SomaLoaderEvent):void

Receives a SomaLoaderEvent.PROGRESS event when a loading of an item progresses.

Parameters
event:SomaLoaderEvent
itemStart()method 
public function itemStart(event:SomaLoaderEvent):void

Receives a SomaLoaderEvent.START event when a loading of an item starts.

Parameters
event:SomaLoaderEvent
queueComplete()method 
public function queueComplete():void

Receives a SomaLoaderEvent.QUEUE_COMPLETE event when the loading of a list of items is complete.

queueProgress()method 
public function queueProgress(event:SomaLoaderEvent):void

Receives a SomaLoaderEvent.QUEUE_PROGRESS event when the loading of a list of items progresses.

Parameters
event:SomaLoaderEvent
queueStart()method 
public function queueStart():void

Receives a SomaLoaderEvent.QUEUE_START event when the loading of a list of items starts.




Soundstep - Soma